-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
294f5f2
commit 33fb844
Showing
1 changed file
with
29 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,47 @@ | ||
| <div align="center"> | ||
|
|
||
| <h1> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="logo_dark.svg"> | ||
| <source media="(prefers-color-scheme: light)" srcset="logo_light.svg"> | ||
| <img alt="Helix" height="128" src="logo_light.svg"> | ||
| </picture> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="logo_dark.svg"> | ||
| <source media="(prefers-color-scheme: light)" srcset="logo_light.svg"> | ||
| <img alt="Helix" height="128" src="logo_light.svg"> | ||
| </picture> | ||
| </h1> | ||
|
|
||
| [](https://github.com/helix-editor/helix/actions) | ||
| [](https://github.com/helix-editor/helix/releases/latest) | ||
| [](https://docs.helix-editor.com/) | ||
| [](https://github.com/helix-editor/helix/graphs/contributors) | ||
| [](https://matrix.to/#/#helix-community:matrix.org) | ||
| [](https://github.com/usagi-flow/helix/actions/workflows/evil-build.yml) | ||
|
|
||
| </div> | ||
|
|
||
|  | ||
| A soft fork of Helix which introduces Vim keybindings. | ||
|
|
||
| A [Kakoune](https://github.com/mawww/kakoune) / [Neovim](https://github.com/neovim/neovim) inspired editor, written in Rust. | ||
| This project is a work-in-progress, but should be stable enough for daily usage, considering that it carefully adds functionality in a non-destructive way. | ||
|
|
||
| The editing model is very heavily based on Kakoune; during development I found | ||
| myself agreeing with most of Kakoune's design decisions. | ||
| ## Installation | ||
|
|
||
| For more information, see the [website](https://helix-editor.com) or | ||
| [documentation](https://docs.helix-editor.com/). | ||
| [Download a package](https://github.com/usagi-flow/helix/releases/tag/feat-evil-base) and extract it in `/opt`. Additionally, it's recommended to symlink it in `/usr/local/bin`: | ||
|
|
||
| All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html). | ||
| ```sh | ||
| cd /opt | ||
| sudo curl -Lo helix.tar.gz https://github.com/usagi-flow/helix/releases/download/feat-evil-base/helix-<ARCH>-<OS>.tar.gz | ||
| sudo tar -xf helix.tar.gz | ||
| cd /usr/local/bin | ||
| sudo ln -sv /opt/helix/hx . | ||
| ``` | ||
|
|
||
| [Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting) | ||
| Builds are not in package repositories yet. | ||
|
|
||
| # Features | ||
| ## Project philosophy | ||
|
|
||
| - Vim-like modal editing | ||
| - Multiple selections | ||
| - Built-in language server support | ||
| - Smart, incremental syntax highlighting and code editing via tree-sitter | ||
| While Helix mostly limits its scope to its current core functionality, and defers further functionality to the future Scheme-based plugin system, | ||
| this fork seeks to implement said functionality as part of the editor. | ||
|
|
||
| It's a terminal-based editor first, but I'd like to explore a custom renderer | ||
| (similar to Emacs) in wgpu or skulpin. | ||
| Implementing features as part of the editor greatly improves performance, and avoids the risk of plugin compatibility issues. | ||
|
|
||
| Note: Only certain languages have indentation definitions at the moment. Check | ||
| `runtime/queries/<lang>/` for `indents.scm`. | ||
| ## Project goals | ||
|
|
||
| # Installation | ||
|
|
||
| [Installation documentation](https://docs.helix-editor.com/install.html). | ||
|
|
||
| [](https://repology.org/project/helix/versions) | ||
|
|
||
| # 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). | ||
|
|
||
| # Credits | ||
|
|
||
| Thanks to [@jakenvac](https://github.com/jakenvac) for designing the logo! | ||
| - Introduce more Vim keybindings | ||
| - Implement common/crucial features as part of the editor: | ||
| - File tree (cf. [upstream PR](https://github.com/helix-editor/helix/pull/5768)) | ||
| - Light/dark mode support (cf. [upstream PR](https://github.com/helix-editor/helix/pull/7788)) | ||
| - Maintain compatibility with upstream | ||
| - Contribute features to upstream where possible |