Skip to content

Commit c656e7c

Browse files
committed
doc: Explain downloading from GitHub vs local compilation
1 parent daac40f commit c656e7c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/emacs-tree-sitter.org

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,12 @@ The author of Tree-sitter articulated its merits a lot better in this [Strange L
3737
#+end_src
3838

3939
{{% notice note %}}
40-
The methods below download pre-compiled binaries, so they only work for macOS, Linux and Windows, on x86_64 machines. For other systems, you will have to build from source.
41-
{{% /notice %}}
40+
Upon byte compilation and first load, the package ~tree-sitter~ (~tsc~) will try to obtain the dynamic module using 2 mechanisms:
41+
- Downloading a pre-compiled binary from GitHub. This only works for macOS/Linux/Windows, on x86_64 machines.
42+
- Compiling the binary from the Rust source. This requires the [[https://rustup.rs/][Rust toolchain]].
4243

43-
# TODO: Document ~tsc-dyn-get-from~ and local compilation.
44+
This behavior can be customized by setting the variable ~tsc-dyn-get-from~, *before tree-sitter (tsc) is byte-compiled/loaded*. Its default value is ~(:github :compilation)~. For example, on Apple Silicon, you should set it to ~(:compilation)~.
45+
{{% /notice %}}
4446

4547
** Installing from MELPA
4648
- Run ~M-x package-refresh-contents~.

0 commit comments

Comments
 (0)