aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBlaž Hrastnik2021-07-17 15:22:58 +0000
committerBlaž Hrastnik2021-07-17 15:22:58 +0000
commit000b7b7c977aef59907011dd9a14d7a5d76826da (patch)
treeece40b6b607a7c510e9075375c72dc21666041ee /README.md
parent722cfedb382abf2a4e48ac45bdfd9b3c5de50a58 (diff)
Make instructions regarding runtime clearer
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 56eddb31..b4f5b867 100644
--- a/README.md
+++ b/README.md
@@ -41,14 +41,17 @@ cargo install --path helix-term
This will install the `hx` binary to `$HOME/.cargo/bin`.
-Now copy the `runtime/` directory somewhere. Helix will by default look for the runtime
-inside the config directory or the same directory as executable, but that can be overriden
+Helix also needs it's 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 overriden
via the `HELIX_RUNTIME` environment variable.
-> NOTE: running via cargo doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
+Packages already solve this for you by wrapping the `hx` binary with a wrapper
+that sets the variable to the install dir.
+
+> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
> detect the `runtime` directory in the project root.
-If you want to embed the `runtime/` directory into the Helix binary you can build
+Alternatively, if you want to embed the `runtime/` directory into the Helix binary you can build
it with:
```