diff --git a/book/src/install.md b/book/src/install.md index bf0ff079c40e..507fd4ada49a 100644 --- a/book/src/install.md +++ b/book/src/install.md @@ -100,8 +100,9 @@ cargo install --path helix-term --locked 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 -via the `HELIX_RUNTIME` environment variable. +config directory (for example `~/.config/helix/runtime` on Linux/macOS). An alternative runtime directory can +be used by setting the `HELIX_RUNTIME` environment variable. Both runtime directories can be used at the same +time, with the files residing under the config runtime directory given priority. | OS | Command | | -------------------- | ------------------------------------------------ | @@ -125,11 +126,6 @@ cd %appdata%\helix mklink /D runtime "\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 --locked`, -> 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).