aboutsummaryrefslogtreecommitdiff
path: root/helix-22.03-x86_64-windows/README.md
diff options
context:
space:
mode:
authorIndrajith K L2022-12-03 17:00:20 +0530
committerIndrajith K L2022-12-03 17:00:20 +0530
commitf5c4671bfbad96bf346bd7e9a21fc4317b4959df (patch)
tree2764fc62da58f2ba8da7ed341643fc359873142f /helix-22.03-x86_64-windows/README.md
downloadcli-tools-windows-master.tar.gz
cli-tools-windows-master.tar.bz2
cli-tools-windows-master.zip
Adds most of the toolsHEADmaster
Diffstat (limited to 'helix-22.03-x86_64-windows/README.md')
-rw-r--r--helix-22.03-x86_64-windows/README.md77
1 files changed, 77 insertions, 0 deletions
diff --git a/helix-22.03-x86_64-windows/README.md b/helix-22.03-x86_64-windows/README.md
new file mode 100644
index 0000000..4052d94
--- /dev/null
+++ b/helix-22.03-x86_64-windows/README.md
@@ -0,0 +1,77 @@
+# 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 https://github.com/helix-editor/helix
+cd helix
+cargo install --path helix-term
+hx --grammar fetch
+hx --grammar build
+```
+
+This will install the `hx` binary to `$HOME/.cargo/bin` and build tree-sitter grammars.
+
+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 overridden 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).