git.iko.soy/helix
on master help sign in
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>

commit02426072cbe4b6272bf54d89f85598bb79a33729 authormatan h <56131718+matan-h@users.noreply.github.com> dateWed 20 Apr 2022, 01:44 (5 years ago) parente452b97
2 files changed+15−3
compare with master
unifiedsplit
README.md+10−3 book/src/install.md+5
README.md+10−3
@@ -32,10 +32,11 @@ Note: Only certain languages have indentation definitions at the moment. Check
3232
3333# Installation
3434
35−We provide packaging for various distributions, but here's a quick method to
36−build from source.
35+Packages are available for various distributions (see [Installation docs](https://docs.helix-editor.com/install.html)).
3736
38−```
37+If you would like to build from source:
38+
39+```shell
3940git clone https://github.com/helix-editor/helix
4041cd helix
4142cargo install --path helix-term
@@ -47,6 +48,12 @@ This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter gr
4748
4849Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
4950config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).
51+
52+| OS | command |
53+|-----------|-----------|
54+|windows |`xcopy runtime %AppData%/helix/runtime`|
55+|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`
56+
5057This location can be overridden via the `HELIX_RUNTIME` environment variable.
5158
5259Packages already solve this for you by wrapping the `hx` binary with a wrapper
book/src/install.md+5
@@ -61,6 +61,11 @@ Helix also needs it's runtime files so make sure to copy/symlink the `runtime/`
6161config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
6262via the `HELIX_RUNTIME` environment variable.
6363
64+| OS | command |
65+|-----------|-----------|
66+|windows |`xcopy runtime %AppData%/helix/runtime`|
67+|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`
68+
6469## Building tree-sitter grammars
6570
6671Tree-sitter grammars must be fetched and compiled if not pre-packaged.