Skip to content

Update installation instructions in the README #863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
geofft wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update installation instructions in the README #863

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,25 @@ A detailed description of the architecture of Git-meta is provided in

## Installation

To install the git-meta plugin:
git-meta currently requires Node.js v16 (LTS) or lower. [nodegit currently does
not work with newer versions of
Node.js.](https://github.com/nodegit/nodegit/issues/1880)

If you don't have a preferred Node.js setup, we suggest installing
[nvm](https://github.com/nvm-sh/nvm), and then installing the Node.js LTS and
Yarn with

```bash
$ nvm install --lts
$ npm install -g yarn
```

To install the git-meta command:

```bash
$ git clone https://github.com/twosigma/git-meta.git
$ cd git-meta/node
$ npm install -g
$ yarn install -g
```

## Quick Start / Basic Usage
Expand Down