git.iko.soy/helix
on master help sign in
Improve and update the installation documentation (#6809)
83c307aDavid Else
book/src/install.md+21−19
compare with master
unifiedsplit
@@ -41,8 +41,6 @@ line.
41
41
42## Linux, macOS, Windows and OpenBSD packaging status
42## Linux, macOS, Windows and OpenBSD packaging status
43
43
44−Helix is available for Linux, macOS and Windows via the official repositories listed below.
45−
46[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
44[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
47
45
48## Linux
46## Linux
@@ -51,7 +49,7 @@ The following third party repositories are available:
51
49
52### Ubuntu
50### Ubuntu
53
51
54−Helix is available via [Maveonair's PPA](https://launchpad.net/~maveonair/+archive/ubuntu/helix-editor):
52+Add the `PPA` for Helix:
55
53
56```sh
54```sh
57sudo add-apt-repository ppa:maveonair/helix-editor
55sudo add-apt-repository ppa:maveonair/helix-editor
@@ -61,7 +59,7 @@ sudo apt install helix
61
59
62### Fedora/RHEL
60### Fedora/RHEL
63
61
64−Helix is available via `copr`:
62+Enable the `COPR` repository for Helix:
65
63
66```sh
64```sh
67sudo dnf copr enable varlad/helix
65sudo dnf copr enable varlad/helix
@@ -92,8 +90,8 @@ If you are using a version of Nix without flakes enabled,
92
90
93### AppImage
91### AppImage
94
92
95−Install Helix using [AppImage](https://appimage.org/).
93+Install Helix using the Linux [AppImage](https://appimage.org/) format.
96−Download Helix AppImage from the [latest releases](https://github.com/helix-editor/helix/releases/latest) page.
94+Download the official Helix AppImage from the [latest releases](https://github.com/helix-editor/helix/releases/latest) page.
97
95
98```sh
96```sh
99chmod +x helix-*.AppImage # change permission for executable mode
97chmod +x helix-*.AppImage # change permission for executable mode
@@ -143,33 +141,37 @@ pacman -S mingw-w64-ucrt-x86_64-helix
143
141
144## Building from source
142## Building from source
145
143
144+Requirements:
145+
146+- The [Rust toolchain](https://www.rust-lang.org/tools/install)
147+- The [Git version control system](https://git-scm.com/)
148+- A c++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang
149+
150+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:
151+
152+```sh
153+RUSTFLAGS="-C target-feature=-crt-static"
154+```
155+
146−Clone the repository:
156+1. Clone the repository:
147
157
148```sh
158```sh
149git clone https://github.com/helix-editor/helix
159git clone https://github.com/helix-editor/helix
150cd helix
160cd helix
151```
161```
152
162
153−Compile from source:
163+2. Compile from source:
154
164
155```sh
165```sh
156cargo install --path helix-term --locked
166cargo install --path helix-term --locked
157```
167```
158
168
159This command will create the `hx` executable and construct the tree-sitter
169This command will create the `hx` executable and construct the tree-sitter
160−grammars in the local `runtime` folder. To build the tree-sitter grammars requires
170+grammars in the local `runtime` folder.
161−a c++ compiler to be installed, for example `gcc-c++`.
162−
163−> 💡 If you are using the musl-libc instead of glibc the following environment variable must be set during the build
164−> to ensure tree-sitter grammars can be loaded correctly:
165−>
166−> ```sh
167−> RUSTFLAGS="-C target-feature=-crt-static"
168−> ```
169
171
170> 💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch
172> 💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch
171−> grammars with `hx --grammar fetch` (requires `git`) and compile them with
173+> grammars with `hx --grammar fetch` and compile them with
172−> `hx --grammar build` (requires a C++ compiler). This will install them in
174+> `hx --grammar build`. This will install them in
173> the `runtime` directory within the user's helix config directory (more
175> the `runtime` directory within the user's helix config directory (more
174> [details below](#multiple-runtime-directories)).
176> [details below](#multiple-runtime-directories)).
175
177