git.iko.soy/helix
on master help sign in
Update windows install instructions (#4351)
8c9bb23Alex
README.md+18−2
compare with master
unifiedsplit
@@ -48,9 +48,25 @@ config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%App
48
48
49| OS | Command |
49| OS | Command |
50| -------------------- | ------------------------------------------------ |
50| -------------------- | ------------------------------------------------ |
51−| Windows (cmd.exe) | `xcopy /e /i runtime %AppData%\helix\runtime` |
51+| Windows (Cmd) | `xcopy /e /i runtime %AppData%\helix\runtime` |
52| Windows (PowerShell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
52| 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+```
54
70
55This location can be overridden via the `HELIX_RUNTIME` environment variable.
71This location can be overridden via the `HELIX_RUNTIME` environment variable.
56
72
book/src/install.md+38−5
@@ -50,6 +50,23 @@ sudo dnf install helix
50sudo xbps-install helix
50sudo xbps-install helix
51```
51```
52
52
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+
53## Build from source
70## Build from source
54
71
55```
72```
@@ -64,11 +81,27 @@ Helix also needs its runtime files so make sure to copy/symlink the `runtime/` d
64config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overridden
81config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overridden
65via the `HELIX_RUNTIME` environment variable.
82via the `HELIX_RUNTIME` environment variable.
66
83
67−| OS | command |
84+| OS | Command |
68−| ------------------- | ------------------------------------------------ |
85+| -------------------- | ------------------------------------------------ |
69−| windows(cmd.exe) | `xcopy /e /i runtime %AppData%/helix/runtime` |
86+| Windows (Cmd) | `xcopy /e /i runtime %AppData%\helix\runtime` |
70−| windows(powershell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
87+| Windows (PowerShell) | `xcopy /e /i runtime $Env:AppData\helix\runtime` |
71−| linux/macos | `ln -s $PWD/runtime ~/.config/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+```
72
105
73To 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:
106To 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:
74
107