helix/README.md

<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>
</h1>

[![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)

</div>

![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.scm`.

# 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 [@JakeHL](https://github.com/JakeHL) for designing the logo!
feat(docs): style readme & add badges (#4970) Centre Helix title and logo and add badge with latest release and link to matrix chat. 2022-12-02 14:56:36 +03:00			`<div align="center">`

Add logo with text included (#4973) 2022-12-03 05:05:15 +03:00			`<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>`
			`</h1>`
Add the new logo! 2022-12-02 06:05:42 +03:00
Fix badge 2021-05-31 15:09:07 +03:00			`[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)`
feat(docs): style readme & add badges (#4970) Centre Helix title and logo and add badge with latest release and link to matrix chat. 2022-12-02 14:56:36 +03:00			`[![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)`

			`</div>`
Fix release packaging. 2021-05-11 13:46:58 +03:00
Add screenshot to README. 2021-05-12 10:49:01 +03:00			`![Screenshot](./screenshot.png)`

Fix typos (#3858) 2022-09-17 14:34:48 +03:00			`A Kakoune / Neovim inspired editor, written in Rust.`
Update README. 2021-05-11 12:50:09 +03:00
Fix typos (#3858) 2022-09-17 14:34:48 +03:00			`The editing model is very heavily based on Kakoune; during development I found`
			`myself agreeing with most of Kakoune's design decisions.`
Update README. 2021-05-11 12:50:09 +03:00
Link to install/keymap docs, fix build status badge 2021-05-31 11:12:09 +03:00			`For more information, see the [website](https://helix-editor.com) or`
			`[documentation](https://docs.helix-editor.com/).`
Fix release packaging. 2021-05-11 13:46:58 +03:00
Update README.md (#581) * Update README.md * Update README.md 2021-08-14 07:28:27 +03:00			`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)`
Release 0.0.10 2021-06-07 03:32:48 +03:00
Update README. 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`
Fix typos (#3858) 2022-09-17 14:34:48 +03:00			`(similar to Emacs) in wgpu or skulpin.`
Split parts of helix-term into helix-view. It still largely depends on term for some types but I plan to change that later. 2020-09-21 12:24:16 +03:00
Release 0.0.10 2021-06-07 03:32:48 +03:00			`Note: Only certain languages have indentation definitions at the moment. Check`
fix(docs): cleanup obsolete indents.toml mentions (#2327) 2022-04-29 20:40:59 +03:00			`runtime/queries/<lang>/` for `indents.scm`.
Add screenshot to README. 2021-05-12 10:49:01 +03:00
Move 'Note' from incorrect location (#921) 2021-10-29 08:11:42 +03:00			`# Installation`

Rewrite and refactor all documentation (#5534) * Rewrite and refactor all documentation * Rewrite and refactor the guides * update runtime directory instructions for windows * Update the Ubuntu 3rd party repo section with 22.10 * Merge from upstream * Rewrite and refactor all documentation * Apply suggestions from code review Apply the suggestions that can be committed from the GitHub web interface. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Add Windows themes folder Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> * Apply the rest of the suggestions from the code review * Revert "Apply the rest of the suggestions from the code review" This reverts commit 498be1b7a1aec3ff567b95130148628beeef9b77. * Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation" This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing changes made to d932969cfc9fadda12a74cc01665919dee7152fb. * Apply code review suggestions * Changes after re-reading all documents * Missed a full stop * Code review suggestions and remove macOS and Windows specific sections * Add OpenBSD to heading * Add back macOS and Windows sections and further simplify and improve * Change wording to nightly * Remove README installation section and turn into a link * Simplify building from source and follow code review suggestions * Code review revisions * Fix copy paste mistake * Apply the latest code review suggestions * More small code review items * Change minor modes for code review * Fix link and typos * Add note that you need a c++ compiler to install the tree-sitter grammars * Add pacman example * Make sure all headings are lower case * Revert to the original passage adding a reference to Windows that was missing * Update book/src/guides/adding_languages.md Fix grammar typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Update book/src/install.md Fix tree sitter typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Remove TOC links to main heading --------- Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com> Co-authored-by: Michael Davis <mcarsondavis@gmail.com> Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> 2023-03-06 12:27:17 +03:00			`[Installation documentation](https://docs.helix-editor.com/install.html).`
Improve documentation on Language Server installation (#2037) 2022-04-09 09:47:32 +03:00
Add repology.org packaging status 2021-06-22 19:05:08 +03:00			`[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)`
Add Arch Linux installation instructions to README 2021-06-01 21:45:07 +03:00
Update README. 2021-05-11 12:50:09 +03:00			`# Contributing`

docs: Auto generate command list 2021-11-17 16:30:11 +03:00			`Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).`
Update README. 2021-05-11 12:50:09 +03:00
			`# Getting help`

Add note about FAQ to `README.md` (#848) 2021-10-16 04:05:29 +03:00			`Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).`

Better link to Matrix 2021-06-05 06:01:48 +03:00			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).
Add the new logo! 2022-12-02 06:05:42 +03:00
			`# Credits`

			`Thanks to [@JakeHL](https://github.com/JakeHL) for designing the logo!`