aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWojciech Kępka2021-06-12 08:20:15 +0000
committerIvan Tham2021-06-12 09:26:41 +0000
commit45793d7c097ca5c9cb9b6eaa13bb1c716ee10d60 (patch)
tree92523f35220b2bbfa594c470608aa44c5ce398b4
parent4b6aff8c66d6c16d16cd80ab3ffb31776ff7bdff (diff)
Update README
-rw-r--r--README.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/README.md b/README.md
index f5a84d5d..fe0c38bc 100644
--- a/README.md
+++ b/README.md
@@ -41,14 +41,12 @@ 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 same folder as the executable, but that can be overriden via
-the `HELIX_RUNTIME` environment variable.
-
-> NOTE: You should set this to <path to repository>/runtime in development (if
-> running via cargo).
->
-> `export HELIX_RUNTIME=$PWD/runtime`
+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
+via the `HELIX_RUNTIME` environment variable.
+
+> NOTE: running via cargo 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
it with: