From 000b7b7c977aef59907011dd9a14d7a5d76826da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bla=C5=BE=20Hrastnik?= Date: Sun, 18 Jul 2021 00:22:58 +0900 Subject: [PATCH] Make instructions regarding runtime clearer --- README.md | 11 +++++++---- 1 file 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: ```