diff options
| author | Greg Troszak | 2022-10-21 00:39:30 +0000 |
|---|---|---|
| committer | GitHub | 2022-10-21 00:39:30 +0000 |
| commit | fbf8078611abc2fa62856c84b758f2943c00cdec (patch) | |
| tree | 7eb7861b8bf03a89ff5137d6e94fd030f1587c60 /book/src | |
| parent | 6a0b450f55675c76d67bfb026caa2df4b601153b (diff) | |
Clarify use of `HELIX_RUNTIME` (#4382)
Diffstat (limited to 'book/src')
| -rw-r--r-- | book/src/install.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/book/src/install.md b/book/src/install.md index 4e7ea8dc..6e2a1f3d 100644 --- a/book/src/install.md +++ b/book/src/install.md @@ -75,7 +75,7 @@ cd helix cargo install --path helix-term ``` -This will install the `hx` binary to `$HOME/.cargo/bin`. +This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars in `./runtime/grammars`. 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 @@ -103,6 +103,15 @@ cd %appdata%\helix mklink /D runtime "<helix-repo>\runtime" ``` +The runtime location can be overridden via the `HELIX_RUNTIME` environment variable. + +> NOTE: if `HELIX_RUNTIME` is set prior to calling `cargo install --path helix-term`, +> tree-sitter grammars will be built in `$HELIX_RUNTIME/grammars`. + +If you plan on keeping the repo locally, an alternative to copying/symlinking +runtime files is to set `HELIX_RUNTIME=/path/to/helix/runtime` +(`HELIX_RUNTIME=$PWD/runtime` if you're in the helix repo directory). + To use Helix in desktop environments that supports [XDG desktop menu](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html), including Gnome and KDE, copy the provided `.desktop` file to the correct folder: ```bash |