git.iko.soy/helix
on master help sign in
add table of OS/command for copy/symlink the runtime folder to the config (#2073)
0242607matan h
README.md+10−3
compare with master
unifiedsplit
@@ -32,10 +32,11 @@ Note: Only certain languages have indentation definitions at the moment. Check
32
32
33# Installation
33# Installation
34
34
35−We provide packaging for various distributions, but here's a quick method to
35+Packages are available for various distributions (see [Installation docs](https://docs.helix-editor.com/install.html)).
36−build from source.
37
36
37+If you would like to build from source:
38+
38−```
39+```shell
39git clone https://github.com/helix-editor/helix
40git clone https://github.com/helix-editor/helix
40cd helix
41cd helix
41cargo install --path helix-term
42cargo install --path helix-term
@@ -47,6 +48,12 @@ This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter gr
47
48
48Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
49Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
49config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).
50config 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+
50This location can be overridden via the `HELIX_RUNTIME` environment variable.
57This location can be overridden via the `HELIX_RUNTIME` environment variable.
51
58
52Packages already solve this for you by wrapping the `hx` binary with a wrapper
59Packages 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/`
61config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
61config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
62via the `HELIX_RUNTIME` environment variable.
62via the `HELIX_RUNTIME` environment variable.
63
63
64+| OS | command |
65+|-----------|-----------|
66+|windows |`xcopy runtime %AppData%/helix/runtime`|
67+|linux/macos|`ln -s $PWD/runtime ~/.config/helix/runtime`
68+
64## Building tree-sitter grammars
69## Building tree-sitter grammars
65
70
66Tree-sitter grammars must be fetched and compiled if not pre-packaged.
71Tree-sitter grammars must be fetched and compiled if not pre-packaged.