summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPascal Kuthe2023-01-18 16:01:17 +0000
committerGitHub2023-01-18 16:01:17 +0000
commit1b69c7b4af8867f46365f6e04ab2ba29676c312c (patch)
tree7634f0ef41b8609d11571f2ccae0a26bb857d391
parent5c7db7aed54f52b3af6102517f81c9d70bb6d1fb (diff)
doc: add build instructions for musl-libc (#5572)
-rw-r--r--book/src/install.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/book/src/install.md b/book/src/install.md
index bf0ff079..e2e546c7 100644
--- a/book/src/install.md
+++ b/book/src/install.md
@@ -99,6 +99,14 @@ cargo install --path helix-term --locked
This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars in `./runtime/grammars`.
+If you are using the musl-libc instead of glibc the following environment variable must be set during the build
+to ensure tree sitter grammars can be loaded correctly:
+
+```
+RUSTFLAGS="-C target-feature=-crt-static"
+```
+
+
Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overridden
via the `HELIX_RUNTIME` environment variable.