Skip to content

Commit 8c9bb23

Browse files
authored
Update windows install instructions (#4351)
1 parent 4174b25 commit 8c9bb23

File tree

2 files changed

+56
-7
lines changed

2 files changed

+56
-7
lines changed

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,25 @@ config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%App
4848

4949
| OS | Command |
5050
| -------------------- | ------------------------------------------------ |
51-
| Windows (cmd.exe) | `xcopy /e /i runtime %AppData%\helix\runtime` |
51+
| Windows (Cmd) | `xcopy /e /i runtime %AppData%\helix\runtime` |
5252
| Windows (PowerShell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
53-
| Linux/macOS | `ln -s $PWD/runtime ~/.config/helix/runtime` |
53+
| Linux / MacOS | `ln -s $PWD/runtime ~/.config/helix/runtime` |
54+
55+
Starting with Windows Vista you can also create symbolic links on Windows. Note that this requires
56+
elevated priviliges - i.e. PowerShell or Cmd must be run as administrator.
57+
58+
**PowerShell:**
59+
60+
```powershell
61+
New-Item -ItemType SymbolicLink -Target "runtime" -Path "$Env:AppData\helix\runtime"
62+
```
63+
64+
**Cmd:**
65+
66+
```cmd
67+
cd %appdata%\helix
68+
mklink /D runtime "<helix-repo>\runtime"
69+
```
5470

5571
This location can be overridden via the `HELIX_RUNTIME` environment variable.
5672

book/src/install.md

+38-5
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,23 @@ sudo dnf install helix
5050
sudo xbps-install helix
5151
```
5252

53+
## Windows
54+
55+
Helix can be installed using [Scoop](https://scoop.sh/) or [Chocolatey](https://chocolatey.org/).
56+
57+
**Scoop:**
58+
59+
```
60+
scoop install helix
61+
```
62+
63+
**Chocolatey:**
64+
65+
```
66+
choco install helix
67+
```
68+
69+
5370
## Build from source
5471

5572
```
@@ -64,11 +81,27 @@ Helix also needs its runtime files so make sure to copy/symlink the `runtime/` d
6481
config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overridden
6582
via the `HELIX_RUNTIME` environment variable.
6683

67-
| OS | command |
68-
| ------------------- | ------------------------------------------------ |
69-
| windows(cmd.exe) | `xcopy /e /i runtime %AppData%/helix/runtime` |
70-
| windows(powershell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
71-
| linux/macos | `ln -s $PWD/runtime ~/.config/helix/runtime` |
84+
| OS | Command |
85+
| -------------------- | ------------------------------------------------ |
86+
| Windows (Cmd) | `xcopy /e /i runtime %AppData%\helix\runtime` |
87+
| Windows (PowerShell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
88+
| Linux / MacOS | `ln -s $PWD/runtime ~/.config/helix/runtime` |
89+
90+
Starting with Windows Vista you can also create symbolic links on Windows. Note that this requires
91+
elevated priviliges - i.e. PowerShell or Cmd must be run as administrator.
92+
93+
**PowerShell:**
94+
95+
```powershell
96+
New-Item -ItemType SymbolicLink -Target "runtime" -Path "$Env:AppData\helix\runtime"
97+
```
98+
99+
**Cmd:**
100+
101+
```cmd
102+
cd %appdata%\helix
103+
mklink /D runtime "<helix-repo>\runtime"
104+
```
72105

73106
To use Helix in desktop environments that supports [XDG desktop menu](https://specifications.freedesktop.org/menu-spec/menu-spec-latest.html), including Gnome and KDE, copy the provided `.desktop` file to the correct folder:
74107

0 commit comments

Comments
 (0)