helix/README.md

63 lines
2.0 KiB
Markdown
Raw Normal View History

# Helix
2021-05-11 13:46:58 +03:00
[![Build status](https://github.com/helix-editor/helix/workflows/ci/badge.svg)](https://github.com/helix-editor/helix/actions)
2021-05-12 10:49:01 +03:00
![Screenshot](./screenshot.png)
2021-05-11 12:50:09 +03: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-11 13:46:58 +03:00
For more information, see the [website](https://helix-editor.com).
2021-05-11 12:50:09 +03: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-10-05 10:12:55 +03:00
# Installation
2021-05-14 19:34:34 +03:00
Note: Only Rust and Golang have indentation definitions at the moment.
2021-05-12 10:49:01 +03:00
2021-05-11 12:50:09 +03:00
We provide packaging for various distributions, but here's a quick method to
build from source.
2020-10-05 10:12:55 +03:00
```
2021-05-11 12:50:09 +03:00
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
2020-10-05 10:12:55 +03:00
cd helix
cargo install --path helix-term
```
This will install the `hx` binary to `$HOME/.cargo/bin`.
2021-05-11 12:50:09 +03: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.
# 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 13:46:58 +03:00
- If your preferred language is missing, integrating a tree-sitter grammar for
2021-05-11 12:50:09 +03: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.
# Getting help
2021-05-30 11:12:43 +03:00
Discuss the project on the community [Matrix channel](https://matrix.to/#/#helix-community:matrix.org).
2021-05-11 12:50:09 +03:00