aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormatan h2022-04-20 01:44:11 +0000
committerGitHub2022-04-20 01:44:11 +0000
commit02426072cbe4b6272bf54d89f85598bb79a33729 (patch)
tree1972d71eaa021efadf110475bbaa437a129985cc
parente452b97cdc7617ec887744b764f1090e440a5983 (diff)
add table of OS/command for copy/symlink the runtime folder to the config (#2073)
* create table of OS and commands in the readme * add link to wiki from health check (without color; just simple println) * move the table from readme to docs and add link from the readme to docs * drop copy on unix,and apply some style fixes from the conversations * by mistake, I edit master insted of develop * remove this file from pr * Update README.md Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * copy table to readme Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
-rw-r--r--README.md13
-rw-r--r--book/src/install.md5
2 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index 6fc98e72..9c7b1177 100644
--- a/README.md
+++ b/README.md
@@ -32,10 +32,11 @@ Note: Only certain languages have indentation definitions at the moment. Check
# Installation
-We provide packaging for various distributions, but here's a quick method to
-build from source.
+Packages are available for various distributions (see [Installation docs](https://docs.helix-editor.com/install.html)).
-```
+If you would like to build from source:
+
+```shell
git clone https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
@@ -47,6 +48,12 @@ This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter gr
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).
+
+| OS | command |
+|-----------|-----------|
+|windows |`xcopy runtime %AppData%/helix/runtime`|
+|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`
+
This location can be overridden via the `HELIX_RUNTIME` environment variable.
Packages already solve this for you by wrapping the `hx` binary with a wrapper
diff --git a/book/src/install.md b/book/src/install.md
index 372ce12a..3329d1c5 100644
--- a/book/src/install.md
+++ b/book/src/install.md
@@ -61,6 +61,11 @@ Helix also needs it's runtime files so make sure to copy/symlink the `runtime/`
config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
via the `HELIX_RUNTIME` environment variable.
+| OS | command |
+|-----------|-----------|
+|windows |`xcopy runtime %AppData%/helix/runtime`|
+|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`
+
## Building tree-sitter grammars
Tree-sitter grammars must be fetched and compiled if not pre-packaged.