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.

Sign up for GitHub

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

Jump to bottom

Clarify the runtime directory location in installation docs #6624

Merged
merged 11 commits into from
Jun 13, 2023
Merged

Clarify the runtime directory location in installation docs #6624

Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2b0bb93
runtime config made clearer
kazimir-malevich Apr 6, 2023
ff837b0
following Unix FHS
kazimir-malevich Apr 7, 2023
1af0b55
we probably want to install Helix as a regular user without sudo access
kazimir-malevich Apr 7, 2023
2c7caf1
suggestions adopted from @the-mikedavis
kazimir-malevich Apr 12, 2023
92fa0c9
attempted to synthesise comments given
kazimir-malevich Apr 19, 2023
0c226f0
I think this may be it
kazimir-malevich May 9, 2023
c58251e
capitalisation of second header
kazimir-malevich May 10, 2023
8a968ed
required changes hopefully made
kazimir-malevich May 11, 2023
fe6fa33
we should have a match now
kazimir-malevich May 13, 2023
f4b3bba
Linux windows dir match
kazimir-malevich Jun 5, 2023
2b608b1
Merge branch 'master' into master
kazimir-malevich Jun 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions book/src/install.md
View file
Open in desktop
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 Down Expand Up @@ -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