on master help sign in
Clarify the runtime directory location in installation docs (#6624)
37fcd16kazimir malevich
book/src/install.md+9−3
@@ -159,6 +159,10 @@ pacman -S mingw-w64-ucrt-x86_64-helix
159
159
160Requirements:
160Requirements:
161
161
162+Clone the Helix GitHub repository into a directory of your choice. The
163+examples in this documentation assume installation into either `~/src/` on
164+Linux and macOS, or `%userprofile%\src\` on Windows.
165+
162- The [Rust toolchain](https://www.rust-lang.org/tools/install)
166- The [Rust toolchain](https://www.rust-lang.org/tools/install)
163- The [Git version control system](https://git-scm.com/)
167- The [Git version control system](https://git-scm.com/)
164- A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang
168- A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang
@@ -195,13 +199,15 @@ grammars in the local `runtime` folder.
195
199
196#### Linux and macOS
200#### Linux and macOS
197
201
202+The **runtime** directory is one below the Helix source, so either set a
198−Either set the `HELIX_RUNTIME` environment variable to point to the runtime files and add it to your `~/.bashrc` or equivalent:
203+`HELIX_RUNTIME` environment variable to point to that directory and add it to
204+your `~/.bashrc` or equivalent:
199
205
200```sh
206```sh
201−HELIX_RUNTIME=/home/user-name/src/helix/runtime
207+HELIX_RUNTIME=~/src/helix/runtime
202```
208```
203
209
204−Or, create a symlink in `~/.config/helix` that links to the source code directory:
210+Or, create a symbolic link:
205
211
206```sh
212```sh
207ln -Ts $PWD/runtime ~/.config/helix/runtime
213ln -Ts $PWD/runtime ~/.config/helix/runtime