ref: c704b808d2d7e12725e9dfb54e7607ec00807583
parent: d51345637841a13a1351bc409588ea5d001d0f8d
author: cancel <cancel@cancel.fm>
date: Tue Dec 4 06:54:01 EST 2018
Add tui controls to README
--- a/README.md
+++ b/README.md
@@ -52,6 +52,8 @@
## Run
+### CLI interpreter
+
The CLI (`orca` binary) reads from a file and runs the orca simulation for 1 timestep (default) or a specified number (`-t` option) and writes the resulting state of the grid to stdout.
```sh
@@ -62,6 +64,26 @@
```sh
echo -e "...\na34\n..." | orca /dev/stdin
```
+
+### Interactive terminal UI
+
+```sh
+tui [options] [file]
+```
+
+Run the interactive terminal UI, useful for debugging or observing behavior.
+
+#### Controls
+
+- `ctrl+q` or `ctrl+d` or `ctrl+g`: quit
+- Arrow keys or `ctrl+h/j/k/l`: move cursor
+- `A`-`Z`, `a`-`z` and `0`-`9`: write character to grid at cursor
+- Spacebar: step the simulation one tick
+- `ctrl+u`: undo
+- `[` and `]`: Adjust cosmetic grid rulers horizontally
+- `{` and `}`: Adjust cosmetic grid rulers vertically+- `(` and `)`: resize grid horizontally
+- `_` and `+`: resize grid vertically
## Extras