Skip to content

Commit

Permalink
add table of OS/command for copy/symlink the runtime folder to the co…
Browse files Browse the repository at this point in the history
…nfig (helix-editor#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>
  • Loading branch information
matan-h and the-mikedavis authored Apr 20, 2022
1 parent e452b97 commit 0242607
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
5 changes: 5 additions & 0 deletions book/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 0242607

Please sign in to comment.