Skip to content

Commit 3563fe0

Browse files
committed
Explain in the docs that npm install supports limited platforms
1 parent b268e41 commit 3563fe0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/section-3-creating-parsers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ In order to develop a Tree-sitter parser, there are two dependencies that you ne
2020

2121
To create a Tree-sitter parser, you need to use [the `tree-sitter` CLI][tree-sitter-cli]. You can install the CLI in a few different ways:
2222

23-
* Install the `tree-sitter-cli` [Node.js module][node-module] using [`npm`][npm], the Node package manager. This is the recommended approach, and it is discussed further in the next section.
23+
* Build the `tree-sitter-cli` [Rust crate][crate] from source using [`cargo`][cargo], the Rust package manager. This works on any platform. See [the contributing docs](/docs/section-5-contributing.md#developing-tree-sitter) for more information.
24+
* Install the `tree-sitter-cli` [Node.js module][node-module] using [`npm`][npm], the Node package manager. This approach is fast, but is only works on certain platforms, because it relies on pre-built binaries.
2425
* Download a binary for your platform from [the latest GitHub release][releases], and put it into a directory on your `PATH`.
25-
* Build the `tree-sitter-cli` [Rust crate][crate] from source using [`cargo`][cargo], the Rust package manager. See [the contributing docs](/docs/section-5-contributing.md#developing-tree-sitter) for more information.
2626

2727
### Project Setup
2828

0 commit comments

Comments
 (0)