mirror of
https://github.com/helix-editor/helix.git
synced 2024-08-17 06:40:47 +03:00
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>
This commit is contained in:
parent
e452b97cdc
commit
02426072cb
13
README.md
13
README.md
@ -32,10 +32,11 @@ # Features
|
||||
|
||||
# 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 @@ # Installation
|
||||
|
||||
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
|
||||
|
@ -61,6 +61,11 @@ ## Build from source
|
||||
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.
|
||||
|
Loading…
Reference in New Issue
Block a user