aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Davis2022-02-14 23:23:35 +0000
committerBlaž Hrastnik2022-03-10 08:31:57 +0000
commit8081e9f0520819309fef9a3df7cad8df24126a28 (patch)
treeae492e5238c2fe9e52476936dc705877a5f8e261 /README.md
parent00b2d616eb6e35f4223e97beced0226cd146b92b (diff)
replace all submodule documentation with flags documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index e8f72b6d..8e4e42d9 100644
--- a/README.md
+++ b/README.md
@@ -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:
```