Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
jooaf committed Aug 10, 2024
1 parent 483e37b commit 7f47149
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,18 @@
My first project in Gleam :) ! This is my attempt of writing
Conway's Game of Life in Gleam.

[![Package Version](https://img.shields.io/hexpm/v/conway_life)](https://hex.pm/packages/conway_life)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/conway_life/)

## CLI
```sh
gleam add conway_life@1
```
```gleam
import conway_life
Welcome to Conway's Game of Life!
pub fn main() {
// TODO: An example of the project in use
}
```
USAGE:
conway_life [ ARGS ] [ --board_size=<INT> --cell_size=<INT> --n_iter=<INT> ]
Further documentation can be found at <https://hexdocs.pm/conway_life>.
FLAGS:
--board_size=<INT> n x n size of the board
--cell_size=<INT> Size of the cell
--help Print help information
--n_iter=<INT> Number of iterations to run the simulation
```
## Development
```sh
gleam run # Run the project
gleam test # Run the tests
```

0 comments on commit 7f47149

Please sign in to comment.