on master help sign in
Make instructions regarding runtime clearer
000b7b7Blaž Hrastnik
README.md+7−4
@@ -41,14 +41,17 @@ cargo install --path helix-term
41
41
42This will install the `hx` binary to `$HOME/.cargo/bin`.
42This will install the `hx` binary to `$HOME/.cargo/bin`.
43
43
44−Now copy the `runtime/` directory somewhere. Helix will by default look for the runtime
44+Helix also needs it's runtime files so make sure to copy/symlink the `runtime/` directory into the
45−inside the config directory or the same directory as executable, but that can be overriden
45+config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
46via the `HELIX_RUNTIME` environment variable.
46via the `HELIX_RUNTIME` environment variable.
47
47
48+Packages already solve this for you by wrapping the `hx` binary with a wrapper
49+that sets the variable to the install dir.
50+
48−> NOTE: running via cargo doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
51+> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
49> detect the `runtime` directory in the project root.
52> detect the `runtime` directory in the project root.
50
53
51−If you want to embed the `runtime/` directory into the Helix binary you can build
54+Alternatively, if you want to embed the `runtime/` directory into the Helix binary you can build
52it with:
55it with:
53
56
54```
57```