From 8a68562bb27048bd65edcaed61ecdb6f4e881415 Mon Sep 17 00:00:00 2001 From: Gabe Cook Date: Sat, 13 Jul 2024 14:28:57 -0500 Subject: [PATCH] docs(readme): Add usage section --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index c6a94f6..2680e96 100644 --- a/README.md +++ b/README.md @@ -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. + +## 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 |