Skip to content

Commit

Permalink
docs(readme): Add usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe565 committed Jul 13, 2024
1 parent 4c05b32 commit 8a68562
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,23 @@ brew install gabe565/tap/cli-of-life

Download and run the [latest release binary](https://github.com/gabe565/cli-of-life/releases/latest) for your system and architecture.
</details>

## Usage
Run `cli-of-life` in a terminal to play.

By default, the grid will be empty, but rle/plaintext files can be loaded with `cli-of-life --file FILE.rle`

See [usage docs](docs/cli-of-life.md) for cli flag documentation.

### Keybinds

| Key | Description |
|---------|------------------------------------|
| Mouse | Place cells |
| `Space` | Play/pause |
| `T` | Tick |
| `M` | Toggle between placing and erasing |
| `W` | Toggle wrapping |
| `<`/`>` | Change playback speed |
| `R` | Reset |
| `Q` | Quit |

0 comments on commit 8a68562

Please sign in to comment.