@ -52,26 +52,13 @@ Run `./tool --help` to see usage info.
## Run
## 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
orca [-t timesteps] infile
```
You can also make orca read from stdin:
```sh
echo -e "...\na34\n..." | orca /dev/stdin
```
### Interactive terminal UI
### Interactive terminal UI
```sh
```sh
tui [options] [file]
orca [options] [file]
```
```
Run the interactive terminal UI, useful for debugging or observing behavior.
Run the interactive terminal UI, useful for debugging or observing behavior. Pass `-h` or `--help` to see command-line argument usage.
#### Controls
#### Controls
@ -80,11 +67,25 @@ Run the interactive terminal UI, useful for debugging or observing behavior.
- `A`-`Z`, `a`-`z`, `0`-`9`, and other printable characters: write character to grid at cursor
- `A`-`Z`, `a`-`z`, `0`-`9`, and other printable characters: write character to grid at cursor
- Spacebar: step the simulation one tick
- Spacebar: step the simulation one tick
- `ctrl+u`: undo
- `ctrl+u`: undo
- `/`: change into or out of key-trigger mode (for the `!` operator)
- `[` and `]`: Adjust cosmetic grid rulers horizontally
- `[` and `]`: Adjust cosmetic grid rulers horizontally
- `{` and `}`: Adjust cosmetic grid rulers vertically
- `{` and `}`: Adjust cosmetic grid rulers vertically
- `(` and `)`: resize grid horizontally
- `(` and `)`: resize grid horizontally
- `_` and `+`: resize grid vertically
- `_` and `+`: resize grid vertically
### CLI interpreter
The CLI (`cli` 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
cli [-t timesteps] infile
```
You can also make `cli` read from stdin:
```sh
echo -e "...\na34\n..." | cli /dev/stdin
```
## Extras
## Extras
- Support this project through [Patreon](https://patreon.com/100).
- Support this project through [Patreon](https://patreon.com/100).