Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the runtime directory location in installation docs #6624

Merged
merged 11 commits into from
Jun 13, 2023
18 changes: 12 additions & 6 deletions book/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,10 @@ pacman -S mingw-w64-ucrt-x86_64-helix

kazimir-malevich marked this conversation as resolved.
Show resolved Hide resolved
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\helix\runtime` on Windows.
the-mikedavis marked this conversation as resolved.
Show resolved Hide resolved
kazimir-malevich marked this conversation as resolved.
Show resolved Hide resolved

- 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
Expand All @@ -179,8 +183,8 @@ cd helix
cargo install --path helix-term --locked
```

This command will create the `hx` executable and construct the tree-sitter
grammars in the local `runtime` folder.
This command will create the `hx` executable and construct the tree-sitter grammars in the
local `runtime` folder.
the-mikedavis marked this conversation as resolved.
Show resolved Hide resolved

> 💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch
> grammars with `hx --grammar fetch` and compile them with
Expand All @@ -192,16 +196,18 @@ 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 -s $PWD/runtime ~/.config/helix/runtime
ln -s ~/src/helix/runtime ~/.config/helix/runtime
```

#### Windows
Expand Down