diff options
Diffstat (limited to 'install.html')
| -rw-r--r-- | install.html | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/install.html b/install.html index 86a8f69e..2c6f3b2e 100644 --- a/install.html +++ b/install.html @@ -198,6 +198,7 @@ <li><a href="#macos">macOS</a> <ul> <li><a href="#homebrew-core">Homebrew Core</a></li> +<li><a href="#macports">MacPorts</a></li> </ul> </li> <li><a href="#windows">Windows</a> @@ -252,14 +253,19 @@ sudo apt update sudo apt install helix </code></pre> <h3 id="fedorarhel"><a class="header" href="#fedorarhel">Fedora/RHEL</a></h3> -<p>Enable the <code>COPR</code> repository for Helix:</p> -<pre><code class="language-sh">sudo dnf copr enable varlad/helix -sudo dnf install helix +<pre><code class="language-sh">sudo dnf install helix </code></pre> <h3 id="arch-linux-extra"><a class="header" href="#arch-linux-extra">Arch Linux extra</a></h3> <p>Releases are available in the <code>extra</code> repository:</p> <pre><code class="language-sh">sudo pacman -S helix </code></pre> +<blockquote> +<p>💡 When installed from the <code>extra</code> repository, run Helix with <code>helix</code> instead of <code>hx</code>.</p> +<p>For example:</p> +<pre><code class="language-sh">helix --health +</code></pre> +<p>to check health</p> +</blockquote> <p>Additionally, a <a href="https://aur.archlinux.org/packages/helix-git/">helix-git</a> package is available in the AUR, which builds the master branch.</p> <h3 id="nixos"><a class="header" href="#nixos">NixOS</a></h3> @@ -293,6 +299,9 @@ Download the official Helix AppImage from the <a href="https://github.com/helix- <h3 id="homebrew-core"><a class="header" href="#homebrew-core">Homebrew Core</a></h3> <pre><code class="language-sh">brew install helix </code></pre> +<h3 id="macports"><a class="header" href="#macports">MacPorts</a></h3> +<pre><code class="language-sh">port install helix +</code></pre> <h2 id="windows"><a class="header" href="#windows">Windows</a></h2> <p>Install on Windows using <a href="https://learn.microsoft.com/en-us/windows/package-manager/winget/">Winget</a>, <a href="https://scoop.sh/">Scoop</a>, <a href="https://chocolatey.org/">Chocolatey</a> or <a href="https://msys2.org/">MSYS2</a>.</p> @@ -322,7 +331,7 @@ Linux and macOS, or <code>%userprofile%\src\</code> on Windows.</p> <li>A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang</li> </ul> <p>If you are using the <code>musl-libc</code> standard library instead of <code>glibc</code> the following environment variable must be set during the build to ensure tree-sitter grammars can be loaded correctly:</p> -<pre><code class="language-sh">RUSTFLAGS="-C target-feature=-crt-static" +<pre><code class="language-sh">RUSTFLAGS="-C target-feature=-crt-static" </code></pre> <ol> <li> @@ -340,6 +349,9 @@ grammars in the local <code>runtime</code> folder.</p> </li> </ol> <blockquote> +<p>💡 If you do not want to fetch or build grammars, set an environment variable <code>HELIX_DISABLE_AUTO_GRAMMAR_BUILD</code></p> +</blockquote> +<blockquote> <p>💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch grammars with <code>hx --grammar fetch</code> and compile them with <code>hx --grammar build</code>. This will install them in @@ -348,10 +360,10 @@ the <code>runtime</code> directory within the user's helix config directory (mor </blockquote> <h3 id="configuring-helixs-runtime-files"><a class="header" href="#configuring-helixs-runtime-files">Configuring Helix's runtime files</a></h3> <h4 id="linux-and-macos"><a class="header" href="#linux-and-macos">Linux and macOS</a></h4> -<p>The <strong>runtime</strong> directory is one below the Helix source, so either set a +<p>The <strong>runtime</strong> directory is one below the Helix source, so either export a <code>HELIX_RUNTIME</code> environment variable to point to that directory and add it to your <code>~/.bashrc</code> or equivalent:</p> -<pre><code class="language-sh">HELIX_RUNTIME=~/src/helix/runtime +<pre><code class="language-sh">export HELIX_RUNTIME=~/src/helix/runtime </code></pre> <p>Or, create a symbolic link:</p> <pre><code class="language-sh">ln -Ts $PWD/runtime ~/.config/helix/runtime @@ -361,7 +373,7 @@ your <code>~/.bashrc</code> or equivalent:</p> <p>Either set the <code>HELIX_RUNTIME</code> environment variable to point to the runtime files using the Windows setting (search for <code>Edit environment variables for your account</code>) or use the <code>setx</code> command in Cmd:</p> -<pre><code class="language-sh">setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime" +<pre><code class="language-sh">setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime" </code></pre> <blockquote> <p>💡 <code>%userprofile%</code> resolves to your user directory like @@ -369,8 +381,8 @@ Cmd:</p> </blockquote> <p>Or, create a symlink in <code>%appdata%\helix\</code> that links to the source code directory:</p> <div class="table-wrapper"><table><thead><tr><th>Method</th><th>Command</th></tr></thead><tbody> -<tr><td>PowerShell</td><td><code>New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime"</code></td></tr> -<tr><td>Cmd</td><td><code>cd %appdata%\helix</code> <br/> <code>mklink /D runtime "%userprofile%\src\helix\runtime"</code></td></tr> +<tr><td>PowerShell</td><td><code>New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime"</code></td></tr> +<tr><td>Cmd</td><td><code>cd %appdata%\helix</code> <br/> <code>mklink /D runtime "%userprofile%\src\helix\runtime"</code></td></tr> </tbody></table> </div> <blockquote> @@ -424,8 +436,8 @@ cp contrib/helix.png ~/.icons # or ~/.local/share/icons </code></pre> <p>To use another terminal than the system default, you can modify the <code>.desktop</code> file. For example, to use <code>kitty</code>:</p> -<pre><code class="language-sh">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 +<pre><code class="language-sh">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 </code></pre> </main> |