github.com/aretext/aretext@v1.3.0/README.md (about) 1 ![Test Status](https://github.com/aretext/aretext/actions/workflows/test.yml/badge.svg) 2 3 aretext 4 ======= 5 6 Minimalist text editor with vim-compatible key bindings. 7 8 [![screencast of aretext](screencast.gif)](https://aretext.org) 9 10 - Simple and consistent terminal-based UI for distraction-free coding. 11 - Efficient editing with over 100 vim commands. 12 - Intuitive and flexible configuration, per language and project. 13 - Seamless integration with CLI tools (bash, tmux, git, code formatters, compilers, and anything else you use). 14 15 *Aretext key bindings are compatible with vim's normal, insert, and visual modes. See [Command Reference](https://aretext.org/docs/command-reference/) for details.* 16 17 Getting Started 18 --------------- 19 20 - [Install](https://aretext.org/docs/install/) 21 - [Quickstart](https://aretext.org/docs/quickstart/) 22 - [User Documentation](https://aretext.org/docs/) 23 - [Cheat Sheet](https://aretext.org/docs/cheat-sheet.html) 24 25 Project Status: Stable and Actively Maintained 26 ---------------------------------------------- 27 28 As of the 1.0 release, I've implemented every feature I wanted in a text editor! I will continue actively maintaining the project, prioritizing stability and performance improvements over new functionality. 29 30 Contributing 31 ------------ 32 33 Contributions are welcome! Please read the [Contribution Guidelines](CONTRIBUTING.md) to get started. 34 35 Developing 36 ---------- 37 38 See [DEVELOPING](DEVELOPING.md) for steps to build, test, and debug aretext. 39 40 Blog Posts and Talks 41 -------------------- 42 43 - [FOSDEM lightning talk (2022)](https://archive.fosdem.org/2022/schedule/event/lt_aretext/), also available [on youtube](https://www.youtube.com/watch?v=NJsWEnM5LcM). 44 - [fuzzy find algorithm](https://devnonsense.com/posts/fuzzy-find-algorithm/) 45 - [fuzzing the aretext markdown parser](https://devnonsense.com/posts/aretext-markdown-fuzz-test/) 46 - [incremental parsing in go](https://devnonsense.com/posts/incremental-parsing-in-go/) 47 - [what's new in aretext 0.5](https://devnonsense.com/posts/aretext-0.5-release/) 48 - [aretext 0.6 released!](https://devnonsense.com/posts/aretext-0.6-release/) 49 - [aretext 0.7 release, thinking about 1.0](https://devnonsense.com/posts/aretext-0.7-release/) 50 - [aretext 1.0 release](https://devnonsense.com/posts/aretext-1.0-release/) 51 52 Copyright and License 53 --------------------- 54 55 Copyright (C) the aretext authors 56 57 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 58 59 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 60 61 You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.