Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eloylp committed Nov 23, 2019
1 parent 4bcbbdc commit 578d806
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# game-of-life
Conway game of life
# Conway`s game-of-life, written in Go .

https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life

## How to install

You must go to [the releases page](https://github.com/eloylp/game-of-life/releases)
and download the latest binary for your architecture.

You can also try this one liner install:
```bash
sudo curl -L "https://github.com/eloylp/game-of-life/releases/download/v1.0.0/gol_1.0.0_Linux_x86_64" \
-o /usr/local/bin/gol \
&& sudo chmod +x /usr/local/bin/gol
```
## How to run

If you want a description about the arguments, just invoke help:
```bash
gol -h
```

Here is a full example of how to use this CLI:
```bash
gol -x 20 -y 20 -g 100 -i 2
```

This will bring more life to your computer !

How to run tests
```bash
go test
```

How to run benchmark tests
```bash
go test -bench=.
```

0 comments on commit 578d806

Please sign in to comment.