diff --git a/README.md b/README.md index c6a94f6..9e9f206 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,29 @@ Run Conway's Game of Life in your terminal! ## Installation +### Docker + +
+ Click to expand + +A Docker image is available at [ghcr.io/gabe565/cli-of-life](https://ghcr.io/gabe565/cli-of-life) + +```shell +sudo docker run --rm -it ghcr.io/gabe565/cli-of-life +``` +
+ +### Homebrew (macOS, Linux) + +
+ Click to expand + +Install cli-of-life from [gabe565/homebrew-tap](https://github.com/gabe565/homebrew-tap): +```shell +brew install gabe565/tap/cli-of-life +``` +
+ ### APT (Ubuntu, Debian)
@@ -66,21 +89,30 @@ Run Conway's Game of Life in your terminal! Install [cli-of-life-bin](https://aur.archlinux.org/packages/cli-of-life-bin) with your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) of choice.
-### Homebrew (macOS, Linux) +### Manual Installation
Click to expand -Install cli-of-life from [gabe565/homebrew-tap](https://github.com/gabe565/homebrew-tap): -```shell -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.
-### Manual Installation +## Usage +Run `cli-of-life` in a terminal to play. -
- Click to expand +By default, the grid will be empty, but rle/plaintext files can be loaded with `cli-of-life --file FILE.rle` -Download and run the [latest release binary](https://github.com/gabe565/cli-of-life/releases/latest) for your system and architecture. -
+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 |