#editor #mode #filter

bin+lib paper

A terminal-based editor with goals to maximize simplicity and efficiency

4 releases (breaking)

0.4.0 Dec 22, 2020
0.3.0 Feb 28, 2019
0.2.0 Jan 18, 2019
0.1.0 Dec 26, 2018

#28 in Text editors

MIT license

72KB
1.5K SLoC

paper

A terminal-based text editor with goals to maximize simplicity and efficiency.

Crates.io docs

This project is very much in an alpha state.

Development

Clone the repository and enter the directory:

git clone https://github.com/jsim2010/paper.git
cd paper

This project uses just for running project-specific commands. If just is not already installed on your system, install it:

cargo install just

To see all available recipes for development, run:

just --list

Note that just v is run by the validate status check required for merging pull requests.

License: MIT


lib.rs:

A terminal-based text editor with goals to maximize simplicity and efficiency.

Design Goals

  1. All functionality shall be able to be performed via the keys reachable from the home row. Where it makes sense, functionality may additionally be performed via the mouse and other keys.
  2. All user input shall be modal, i.e. keys may implement different functionality depending on the current mode of the application.
  3. Paper shall utilize already implemented tools and commands wherever possible; specifically paper shall support the Language Server Protocol.

Dependencies

~24MB
~530K SLoC