From 2244a5d40c83d477839f91cb6d6a4aeb02446a97 Mon Sep 17 00:00:00 2001 From: omentic Date: Wed, 1 May 2024 23:29:52 +0000 Subject: deploy: 12eec890240a05d1e090114f7f4fdd7c1ee8ff88 --- install.html | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) (limited to 'install.html') diff --git a/install.html b/install.html index 86a8f69e..2c6f3b2e 100644 --- a/install.html +++ b/install.html @@ -198,6 +198,7 @@
Enable the COPR
repository for Helix:
sudo dnf copr enable varlad/helix
-sudo dnf install helix
+sudo dnf install helix
Arch Linux extra
Releases are available in the extra
repository:
sudo pacman -S helix
+
+💡 When installed from the extra
repository, run Helix with helix
instead of hx
.
+For example:
+helix --health
+
+to check health
+
Additionally, a helix-git package is available
in the AUR, which builds the master branch.
NixOS
@@ -293,6 +299,9 @@ Download the official Helix AppImage from the Homebrew Core
brew install helix
+MacPorts
+port install helix
+
Windows
Install on Windows using Winget, Scoop, Chocolatey
or MSYS2.
@@ -322,7 +331,7 @@ Linux and macOS, or %userprofile%\src\
on Windows.
A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang
If you are using the musl-libc
standard library instead of glibc
the following environment variable must be set during the build to ensure tree-sitter grammars can be loaded correctly:
-RUSTFLAGS="-C target-feature=-crt-static"
+RUSTFLAGS="-C target-feature=-crt-static"
-
@@ -340,6 +349,9 @@ grammars in the local
runtime
folder.
+💡 If you do not want to fetch or build grammars, set an environment variable HELIX_DISABLE_AUTO_GRAMMAR_BUILD
+
+
💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch
grammars with hx --grammar fetch
and compile them with
hx --grammar build
. This will install them in
@@ -348,10 +360,10 @@ the runtime
directory within the user's helix config directory (mor
Configuring Helix's runtime files
Linux and macOS
-The runtime directory is one below the Helix source, so either set a
+
The runtime directory is one below the Helix source, so either export a
HELIX_RUNTIME
environment variable to point to that directory and add it to
your ~/.bashrc
or equivalent:
-HELIX_RUNTIME=~/src/helix/runtime
+export HELIX_RUNTIME=~/src/helix/runtime
Or, create a symbolic link:
ln -Ts $PWD/runtime ~/.config/helix/runtime
@@ -361,7 +373,7 @@ your ~/.bashrc
or equivalent:
Either set the HELIX_RUNTIME
environment variable to point to the runtime files using the Windows setting (search for
Edit environment variables for your account
) or use the setx
command in
Cmd:
-setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime"
+setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime"
💡 %userprofile%
resolves to your user directory like
@@ -369,8 +381,8 @@ Cmd:
Or, create a symlink in %appdata%\helix\
that links to the source code directory:
Method Command
-PowerShell New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime"
-Cmd cd %appdata%\helix
mklink /D runtime "%userprofile%\src\helix\runtime"
+PowerShell New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime"
+Cmd cd %appdata%\helix
mklink /D runtime "%userprofile%\src\helix\runtime"
@@ -424,8 +436,8 @@ cp contrib/helix.png ~/.icons # or ~/.local/share/icons
To use another terminal than the system default, you can modify the .desktop
file. For example, to use kitty
:
-sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
-sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
+sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
+sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
--
cgit v1.2.3-70-g09d2