aboutsummaryrefslogtreecommitdiff
path: root/book/src
diff options
context:
space:
mode:
authorkazimir malevich2023-06-13 01:35:12 +0000
committerGitHub2023-06-13 01:35:12 +0000
commit37fcd160db610feb4a910a3c587cc73a3a2e6635 (patch)
tree3c4ddded65fa5a867ecf4dbd8cc5c234a378e1cf /book/src
parent0e42e4e193c65f0e9489e9cf871dbd58eba2b12e (diff)
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
Diffstat (limited to 'book/src')
-rw-r--r--book/src/install.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/book/src/install.md b/book/src/install.md
index 0b5e1a30..f7ffa42f 100644
--- a/book/src/install.md
+++ b/book/src/install.md
@@ -159,6 +159,10 @@ pacman -S mingw-w64-ucrt-x86_64-helix
Requirements:
+Clone the Helix GitHub repository into a directory of your choice. The
+examples in this documentation assume installation into either `~/src/` on
+Linux and macOS, or `%userprofile%\src\` on Windows.
+
- The [Rust toolchain](https://www.rust-lang.org/tools/install)
- The [Git version control system](https://git-scm.com/)
- 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.
#### Linux and macOS
-Either set the `HELIX_RUNTIME` environment variable to point to the runtime files and add it to your `~/.bashrc` or equivalent:
+The **runtime** directory is one below the Helix source, so either set a
+`HELIX_RUNTIME` environment variable to point to that directory and add it to
+your `~/.bashrc` or equivalent:
```sh
-HELIX_RUNTIME=/home/user-name/src/helix/runtime
+HELIX_RUNTIME=~/src/helix/runtime
```
-Or, create a symlink in `~/.config/helix` that links to the source code directory:
+Or, create a symbolic link:
```sh
ln -Ts $PWD/runtime ~/.config/helix/runtime