From 33fb8447777d9fa32e3740dbd4294e5a3014d6d7 Mon Sep 17 00:00:00 2001 From: usagi-flow <2804556+usagi-flow@users.noreply.github.com> Date: Wed, 15 May 2024 20:56:11 +0200 Subject: [PATCH] doc(evil): Update README.md --- README.md | 75 +++++++++++++++++++++---------------------------------- 1 file changed, 29 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 3f166db1b..15f912695 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,47 @@

- - - - Helix - + + + + Helix +

-[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions) -[![GitHub Release](https://img.shields.io/github/v/release/helix-editor/helix)](https://github.com/helix-editor/helix/releases/latest) -[![Documentation](https://shields.io/badge/-documentation-452859)](https://docs.helix-editor.com/) -[![GitHub contributors](https://img.shields.io/github/contributors/helix-editor/helix)](https://github.com/helix-editor/helix/graphs/contributors) -[![Matrix Space](https://img.shields.io/matrix/helix-community:matrix.org)](https://matrix.to/#/#helix-community:matrix.org) +[![Build status](https://img.shields.io/github/actions/workflow/status/usagi-flow/helix/evil-build.yml?style=for-the-badge&logo=github)](https://github.com/usagi-flow/helix/actions/workflows/evil-build.yml)
-![Screenshot](./screenshot.png) +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--.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//` for `indents.scm`. +## Project goals -# Installation - -[Installation documentation](https://docs.helix-editor.com/install.html). - -[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](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 \ No newline at end of file