![audit](https://github.com/nadmax/revise/actions/workflows/audit.yml/badge.svg) ![build](https://github.com/nadmax/revise/actions/workflows/build.yml/badge.svg) ![test](https://github.com/nadmax/revise/actions/workflows/test.yml/badge.svg)

# Revise

A minimalist text editor written in Rust.

<img width=840 height=310 src="https://github.com/nadmax/revise/blob/master/static/revise.png?raw=true" alt="Revise editor screenshot"/>

## Prerequisites

In order to use revise, you need to install Cargo.
See [Installation Guide](https://www.rust-lang.org/tools/install)

## Installation
Run the following command to install Revise
```
cargo install revise
```

## Usage
To start using Revise, run the following command
```
revise <file>
```

## Contributing
See [Contributing Section](https://github.com/nadmax/revise/blob/master/CONTRIBUTING.md) to find out how you can contribute.  
Any feedback will be appreciated.