suimeng
/
helix
mirror of https://github.com/helix-editor/helix
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
pull/2193/head
matan h 2022-04-20 01:44:11 +00:00 committed by GitHub
parent e452b97cdc
commit 02426072cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -32,10 +32,11 @@ Note: Only certain languages have indentation definitions at the moment. Check
# Installation # Installation
We provide packaging for various distributions, but here's a quick method to Packages are available for various distributions (see [Installation docs](https://docs.helix-editor.com/install.html)).
build from source.
``` If you would like to build from source:
```shell
git clone https://github.com/helix-editor/helix git clone https://github.com/helix-editor/helix
cd helix cd helix
cargo install --path helix-term 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 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). 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. 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 Packages already solve this for you by wrapping the `hx` binary with a wrapper

5
book/src/install.md
View File

@ -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 config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden
via the `HELIX_RUNTIME` environment variable. 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 ## Building tree-sitter grammars
Tree-sitter grammars must be fetched and compiled if not pre-packaged. Tree-sitter grammars must be fetched and compiled if not pre-packaged.