From 8081e9f0520819309fef9a3df7cad8df24126a28 Mon Sep 17 00:00:00 2001 From: Michael Davis Date: Mon, 14 Feb 2022 17:23:35 -0600 Subject: replace all submodule documentation with flags documentation --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'README.md') 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: ``` -- cgit v1.2.3-70-g09d2