Skip to content

Commit

Permalink
Update install.md instructions regarding symlinks (helix-editor#7231)
Browse files Browse the repository at this point in the history
* Update install.md

Fixes `ln` command line bug that could hit users moving from packaged to source builds.

* Remove extra 'how to' command example
  • Loading branch information
rseymour authored and mtoohey31 committed Jun 2, 2024
1 parent 9f442e3 commit 5e97538
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion book/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5e97538

Please sign in to comment.