Add readme
This commit is contained in:
parent
2534cbf32c
commit
6afee2d102
31
README.md
Normal file
31
README.md
Normal 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) |
|
Loading…
Reference in New Issue
Block a user