mirrors/helix
1
0
Fork 0
mirror of https://github.com/helix-editor/helix.git synced 2025-04-03 19:07:44 +03:00
Code Issues Projects Releases Packages Wiki Activity

replace all submodule documentation with flags documentation

Browse source
This commit is contained in:
Michael Davis 2022-02-14 17:23:35 -06:00 • committed by Blaž Hrastnik
parent 00b2d616eb
commit 8081e9f052
6 changed files with 94 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -36,12 +36,14 @@ We provide packaging for various distributions, but here's a quick method to
build from source.
```
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
git clone https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
hx --fetch-grammars
hx --build-grammars
```
This will install the `hx` binary to `$HOME/.cargo/bin`.
This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars.
Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).
@ -56,6 +58,7 @@ that sets the variable to the install dir.
[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
## MacOS
Helix can be installed on MacOS through homebrew via:
```