on master help sign in
Clarify the runtime directory location in installation docs (#6624)

* runtime config made clearer * following Unix FHS * we probably want to install Helix as a regular user without sudo access * suggestions adopted from @the-mikedavis * attempted to synthesise comments given * capitalisation of second header * required changes hopefully made * we should have a match now * Linux windows dir match

commit37fcd160db610feb4a910a3c587cc73a3a2e6635 authorkazimir malevich <64121410+kazimir-malevich@users.noreply.github.com> dateTue 13 Jun 2023, 02:35 (3 years ago) parent0e42e4e
1 file changed+9−3
book/src/install.md+9−3
book/src/install.md+9−3
@@ -159,6 +159,10 @@ pacman -S mingw-w64-ucrt-x86_64-helix
159159
160160Requirements:
161161
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+
162166- The [Rust toolchain](https://www.rust-lang.org/tools/install)
163167- The [Git version control system](https://git-scm.com/)
164168- 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.
195199
196200#### Linux and macOS
197201
198−Either set the `HELIX_RUNTIME` environment variable to point to the runtime files and add it to your `~/.bashrc` or equivalent:
202+The **runtime** directory is one below the Helix source, so either set a
203+`HELIX_RUNTIME` environment variable to point to that directory and add it to
204+your `~/.bashrc` or equivalent:
199205
200206```sh
201−HELIX_RUNTIME=/home/user-name/src/helix/runtime
207+HELIX_RUNTIME=~/src/helix/runtime
202208```
203209
204−Or, create a symlink in `~/.config/helix` that links to the source code directory:
210+Or, create a symbolic link:
205211
206212```sh
207213ln -Ts $PWD/runtime ~/.config/helix/runtime