Add readme

This commit is contained in:
Patrick Auernig 2023-08-09 15:26:20 +02:00
parent 2534cbf32c
commit 6afee2d102

31
README.md Normal file
View File

@ -0,0 +1,31 @@
# Wayfarer
> A simple TUI application to display Journey savefiles.
## How to install
Simply install it with cargo.
```sh
cargo install --git https://github.com/valeth/wayfarer
```
Make sure the path cargo installs to is in your system's `PATH`.
```sh
wayfarer tui <path-to-savefile>
# or
wayfarer show <path-to-savefile>
```
## TUI Keybindings
| Key | Description |
|:---:| --------------------------------------------------- |
| ESC | Return to "normal mode" |
| q | Quits the application |
| o | Open a new file |
| w | Toggle file watcher mode (requires "watch" feature) |