2020-09-21 11:24:16 +02:00
|
|
|
# Helix
|
|
|
|
|
|
2021-05-11 12:46:58 +02:00
|
|
|
|
2021-05-31 14:09:07 +02:00
|
|
|
[](https://github.com/helix-editor/helix/actions)
|
2021-05-11 12:46:58 +02:00
|
|
|
|
2021-05-12 09:49:01 +02:00
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
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/).
|
2021-05-11 12:46:58 +02:00
|
|
|
|
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.
|
2020-09-21 11:24:16 +02:00
|
|
|
|
2020-10-05 09:12:55 +02:00
|
|
|
# Installation
|
|
|
|
|
|
2021-05-14 18:34:34 +02:00
|
|
|
Note: Only Rust and Golang have indentation definitions at the moment.
|
2021-05-12 09:49:01 +02:00
|
|
|
|
2021-05-11 11:50:09 +02:00
|
|
|
We provide packaging for various distributions, but here's a quick method to
|
|
|
|
|
build from source.
|
|
|
|
|
|
2020-10-05 09:12:55 +02:00
|
|
|
```
|
2021-05-11 11:50:09 +02:00
|
|
|
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
|
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`.
|
|
|
|
|
|
2021-05-11 11:50:09 +02:00
|
|
|
Now copy the `runtime/` directory somewhere. Helix will by default look for the
|
|
|
|
|
runtime inside the same folder as the executable, but that can be overriden via
|
|
|
|
|
the `HELIX_RUNTIME` environment variable.
|
|
|
|
|
|
2021-06-02 04:14:46 +02:00
|
|
|
> NOTE: You should set this to <path to repository>/runtime in development (if
|
|
|
|
|
> running via cargo).
|
|
|
|
|
|
2021-06-01 20:45:07 +02:00
|
|
|
## Arch Linux
|
|
|
|
|
There are two packages available from AUR:
|
|
|
|
|
- `helix-bin`: contains prebuilt binary from GitHub releases
|
|
|
|
|
- `helix-git`: builds the master branch of this repository
|
|
|
|
|
|
2021-05-11 11:50:09 +02:00
|
|
|
# Contributing
|
|
|
|
|
|
|
|
|
|
Contributors are very welcome! **No contribution is too small and all contributions are valued.**
|
|
|
|
|
|
|
|
|
|
Some suggestions to get started:
|
|
|
|
|
|
|
|
|
|
- You can look at the [good first issue](https://github.com/helix-editor/helix/labels/good%20first%20issue) label on the issue tracker.
|
|
|
|
|
- Help with packaging on various distributions needed!
|
2021-05-11 12:46:58 +02:00
|
|
|
- If your preferred language is missing, integrating a tree-sitter grammar for
|
2021-05-11 11:50:09 +02:00
|
|
|
it and defining syntax highlight queries for it is straight forward and
|
|
|
|
|
doesn't require much knowledge of the internals.
|
|
|
|
|
|
|
|
|
|
We provide an [architecture.md](./docs/architecture.md) that should give you
|
|
|
|
|
a good overview of the internals.
|
|
|
|
|
|
2021-06-02 12:05:39 +02:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
### Shortcuts
|
|
|
|
|
- <space>f - fuzzy searching of open files in the buffer
|
|
|
|
|
|
2021-05-11 11:50:09 +02:00
|
|
|
# Getting help
|
|
|
|
|
|
2021-05-30 10:12:43 +02:00
|
|
|
Discuss the project on the community [Matrix channel](https://matrix.to/#/#helix-community:matrix.org).
|
2021-05-11 11:50:09 +02:00
|
|
|
|
