aboutsummaryrefslogtreecommitdiff
path: root/book
diff options
context:
space:
mode:
authorRich Seymour2023-06-05 00:06:25 +0000
committerGitHub2023-06-05 00:06:25 +0000
commit751da0130322b63c5233904ecd2f7ff1c068c4e7 (patch)
tree023dbc76922bfca34a8da0dba5bd89bd91ff6aff /book
parent232d9f96a0d9144457716ec0a9309db2f6924ac8 (diff)
Update install.md instructions regarding symlinks (#7231)
* Update install.md Fixes `ln` command line bug that could hit users moving from packaged to source builds. * Remove extra 'how to' command example
Diffstat (limited to 'book')
-rw-r--r--book/src/install.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/book/src/install.md b/book/src/install.md
index 8d80712f..7483be29 100644
--- a/book/src/install.md
+++ b/book/src/install.md
@@ -204,9 +204,11 @@ HELIX_RUNTIME=/home/user-name/src/helix/runtime
Or, create a symlink in `~/.config/helix` that links to the source code directory:
```sh
-ln -s $PWD/runtime ~/.config/helix/runtime
+ln -Ts $PWD/runtime ~/.config/helix/runtime
```
+If the above command fails to create a symbolic link because the file exists either move `~/.config/helix/runtime` to a new location or delete it, then run the symlink command above again.
+
#### Windows
Either set the `HELIX_RUNTIME` environment variable to point to the runtime files using the Windows setting (search for