on master help sign in
Make instructions regarding runtime clearer
commit000b7b7c977aef59907011dd9a14d7a5d76826da authorBlaž Hrastnik <blaz@mxxn.io> dateSun 18 Jul 2021, 00:22 (5 years ago) parent722cfed
1 file changed+7−4
README.md+7−4
README.md+7−4
@@ -41,14 +41,17 @@ cargo install --path helix-term
4141
4242This will install the `hx` binary to `$HOME/.cargo/bin`.
4343
44−Now copy the `runtime/` directory somewhere. Helix will by default look for the runtime
45−inside the config directory or the same directory as executable, but that can be overriden
44+Helix also needs it's runtime files so make sure to copy/symlink the `runtime/` directory into the
45+config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
4646via the `HELIX_RUNTIME` environment variable.
4747
48−> NOTE: running via cargo doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
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+
51+> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
4952> detect the `runtime` directory in the project root.
5053
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
5255it with:
5356
5457```