-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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=. | ||
``` |