From 3563fe009aa3cf373ae01782979743e6aa258a0a Mon Sep 17 00:00:00 2001 From: Max Brunsfeld Date: Fri, 2 Sep 2022 15:31:21 -0700 Subject: [PATCH] Explain in the docs that npm install supports limited platforms --- docs/section-3-creating-parsers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/section-3-creating-parsers.md b/docs/section-3-creating-parsers.md index 05824e22..0720d1e1 100644 --- a/docs/section-3-creating-parsers.md +++ b/docs/section-3-creating-parsers.md @@ -20,9 +20,9 @@ In order to develop a Tree-sitter parser, there are two dependencies that you ne 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: -* 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. +* 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. +* 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. * Download a binary for your platform from [the latest GitHub release][releases], and put it into a directory on your `PATH`. -* 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. ### Project Setup