helix-mods/README.md

# Helix


[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)

![Screenshot](./screenshot.png)

A kakoune / neovim inspired editor, written in Rust.

The editing model is very heavily based on kakoune; during development I found
myself agreeing with most of kakoune's design decisions.

For more information, see the [website](https://helix-editor.com) or
[documentation](https://docs.helix-editor.com/).

All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).

[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)

# Features

- Vim-like modal editing
- Multiple selections
- Built-in language server support
- Smart, incremental syntax highlighting and code editing via tree-sitter

It's a terminal-based editor first, but I'd like to explore a custom renderer
(similar to emacs) in wgpu or skulpin.

Note: Only certain languages have indentation definitions at the moment. Check
`runtime/queries/<lang>/` for `indents.toml`.

# Installation

We provide packaging for various distributions, but here's a quick method to
build from source.

```
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
```

This will install the `hx` binary to `$HOME/.cargo/bin`.

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).
This location can be overriden via the `HELIX_RUNTIME` environment variable.

Packages already solve this for you by wrapping the `hx` binary with a wrapper
that sets the variable to the install dir.

> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
> detect the `runtime` directory in the project root.

[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)

## MacOS
Helix can be installed on MacOS through homebrew via:

```
brew tap helix-editor/helix
brew install helix
```
 
# Contributing

Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).

# Getting help

Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).

Discuss the project on the community [Matrix Space](https://matrix.to/#/#helix-community:matrix.org) (make sure to join `#helix-editor:matrix.org` if you're on a client that doesn't support Matrix Spaces yet).
Split parts of helix-term into helix-view. It still largely depends on term for some types but I plan to change that later. 2020-09-21 11:24:16 +02:00			`# Helix`

Fix release packaging. 2021-05-11 12:46:58 +02:00
Fix badge 2021-05-31 14:09:07 +02:00			`[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)`
Fix release packaging. 2021-05-11 12:46:58 +02:00
Add screenshot to README. 2021-05-12 09:49:01 +02:00			`![Screenshot](./screenshot.png)`

Update README. 2021-05-11 11:50:09 +02:00			`A kakoune / neovim inspired editor, written in Rust.`

			`The editing model is very heavily based on kakoune; during development I found`
			`myself agreeing with most of kakoune's design decisions.`

Link to install/keymap docs, fix build status badge 2021-05-31 10:12:09 +02:00			`For more information, see the [website](https://helix-editor.com) or`
			`[documentation](https://docs.helix-editor.com/).`
Fix release packaging. 2021-05-11 12:46:58 +02:00
Update README.md (#581) * Update README.md * Update README.md 2021-08-14 06:28:27 +02:00			`All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).`

			`[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)`
Release 0.0.10 2021-06-07 02:32:48 +02:00
Update README. 2021-05-11 11:50:09 +02:00			`# Features`

			`- Vim-like modal editing`
			`- Multiple selections`
			`- Built-in language server support`
			`- Smart, incremental syntax highlighting and code editing via tree-sitter`

			`It's a terminal-based editor first, but I'd like to explore a custom renderer`
			`(similar to emacs) in wgpu or skulpin.`
Split parts of helix-term into helix-view. It still largely depends on term for some types but I plan to change that later. 2020-09-21 11:24:16 +02:00
Release 0.0.10 2021-06-07 02:32:48 +02:00			`Note: Only certain languages have indentation definitions at the moment. Check`
Update `README.md` 2021-08-02 08:22:50 +02:00			`runtime/queries/<lang>/` for `indents.toml`.
Add screenshot to README. 2021-05-12 09:49:01 +02:00
Move 'Note' from incorrect location (#921) 2021-10-29 07:11:42 +02:00			`# Installation`

Update README. 2021-05-11 11:50:09 +02:00			`We provide packaging for various distributions, but here's a quick method to`
			`build from source.`

Update README. 2020-10-05 09:12:55 +02:00			```
Update README. 2021-05-11 11:50:09 +02:00			`git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix`
Update README. 2020-10-05 09:12:55 +02:00			`cd helix`
			`cargo install --path helix-term`
			```

			This will install the `hx` binary to `$HOME/.cargo/bin`.

Fix it's -> its (#676) 2021-08-30 10:58:22 +02:00			Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the
In README, add example for windows config directory (#1273) * better doc for windows user * fix doc 2021-12-16 02:48:49 +01:00			config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows).
			This location can be overriden via the `HELIX_RUNTIME` environment variable.
Update README 2021-06-12 10:20:15 +02:00
Make instructions regarding runtime clearer 2021-07-17 17:22:58 +02:00			Packages already solve this for you by wrapping the `hx` binary with a wrapper
			`that sets the variable to the install dir.`

			> NOTE: running via cargo also doesn't require setting explicit `HELIX_RUNTIME` path, it will automatically
Update README 2021-06-12 10:20:15 +02:00			> detect the `runtime` directory in the project root.
Update install notes 2021-06-02 04:14:46 +02:00
Add repology.org packaging status 2021-06-22 18:05:08 +02:00			`[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)`
Add Arch Linux installation instructions to README 2021-06-01 20:45:07 +02:00
Install instructions and version number corrections (#148) * Add MacOS install instructions * Change version name argument When using the -V command to get the version you are given 'helix-term x.x.x', I changed this to just helix as it makes more sense. * Fixed version number * Fixed version number * Fixed version number * Fixed version number * Fixed version number * Fixed version number 2021-06-07 02:14:06 +02:00			`## MacOS`
			`Helix can be installed on MacOS through homebrew via:`

			```
			`brew tap helix-editor/helix`
			`brew install helix`
			```

Update README. 2021-05-11 11:50:09 +02:00			`# Contributing`

docs: Auto generate command list 2021-11-17 14:30:11 +01:00			`Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).`
Update README. 2021-05-11 11:50:09 +02:00
			`# Getting help`

Add note about FAQ to `README.md` (#848) 2021-10-16 03:05:29 +02:00			`Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).`

Better link to Matrix 2021-06-05 05:01:48 +02:00			Discuss the project on the community [Matrix Space](https://matrix.to/#/#helix-community:matrix.org) (make sure to join `#helix-editor:matrix.org` if you're on a client that doesn't support Matrix Spaces yet).