valeth/wayfarer
1
0
Fork 0
Code Releases Activity

Update readme

Browse Source 
Expand keybinding section
This commit is contained in:
Patrick Auernig 2023-08-18 16:43:28 +02:00
parent 1223dc190a
commit c9d08421fa
1 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -12,24 +12,29 @@ cargo install --git https://github.com/valeth/wayfarer
Make sure the path cargo installs to is in your system's `PATH`.
Then simply run it with
```sh
wayfarer
# of if you want to override the last remembered file
wayfarer --path <path-to-savefile>
```
Use `--help` to see a list of available options.
## TUI Keybindings
| Key | Mode | Description |
|:--------:|:------:| --------------------------------------------------- |
| ESC | Any | Return to "normal mode" |
| Ctrl + q | Any | Quits the application |
| q | Normal | Quits the application |
| o | Normal | Open a new file |
| w | Normal | Toggle file watcher mode (requires "watch" feature) |
| e | Normal | Enter edit mode |
| H,J,K,L | Edit | Move between sections |
| h,j,k,l | Edit | Move inside the current section |
| Key | Mode | Description |
|:-----------:|:------:| --------------------------------------------------- |
| ESC | Any | Return to "normal mode" or cancel action |
| Ctrl + q | Any | Quits the application |
| q | Normal | Quits the application |
| e | Normal | Enter edit mode |
| o | Normal | Open a new file |
| r | Normal | Reload the current file |
| w | Normal | Toggle file watcher mode (requires "watch" feature) |
| h, j, k, l | Edit | Move inside the current section |
| H, J, K, L | Edit | Move between sections |
| n, p | Edit | Cycle through entry values |
| s | Edit | Save current edit |
| Enter | Edit | Begin editing entry |
| Enter | Insert | Commit entry edit |