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 e4d66e3
Showing 1 changed file with 42 additions and 10 deletions.
52 changes: 42 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,29 @@ Run Conway's Game of Life in your terminal!

## Installation

### Docker

<details>
<summary>Click to expand</summary>

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
```
</details>

### Homebrew (macOS, Linux)

<details>
<summary>Click to expand</summary>

Install cli-of-life from [gabe565/homebrew-tap](https://github.com/gabe565/homebrew-tap):
```shell
brew install gabe565/tap/cli-of-life
```
</details>

### APT (Ubuntu, Debian)

<details>
Expand Down Expand Up @@ -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.
</details>

### Homebrew (macOS, Linux)
### Manual Installation

<details>
<summary>Click to expand</summary>

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.
</details>

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

<details>
<summary>Click to expand</summary>
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.
</details>
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 e4d66e3

Please sign in to comment.