Skip to content

Commit

Permalink
Changed HELIX_RUNTIME build from src instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Scott committed Jan 18, 2023
1 parent 7bd25d8 commit 36b98c0
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions book/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,9 @@ cargo install --path helix-term
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 |
| -------------------- | ------------------------------------------------ |
Expand All @@ -123,13 +124,6 @@ mklink /D runtime "<helix-repo>\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`,
> 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).

To use Helix in desktop environments that supports [XDG desktop menu](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html), including Gnome and KDE, copy the provided `.desktop` file to the correct folder:

```bash
Expand Down

0 comments on commit 36b98c0

Please sign in to comment.