summaryrefslogtreecommitdiffstats
path: root/CLI/rust/README.md
blob: d6e5de08f64a43421b671bea6649ea42b8983ad3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# GameOfLife

The implementation of the [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) rust package

## Installation
TBD

## Usage
TBD

## Demo
TBD

## Development
- Install rustup via `curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh`
- Install rust stable version for development `rustup update`
- Install rust nightly for testing via `rustup install nightly`
- run `cargo build` to build the crate/CLI binaries.
- run `cargo run --` to run the built binaries.


## Linting
TBD

## Testing
Run `cargo +nightly test`

## Documentation
Run `cargo doc`

## Release
TBD

## Extra information
### [Contributing](https://gitlab.com/a14m/game-of-life/-/blob/master/CONTRIBUTING.md)
### [License](https://gitlab.com/a14m/game-of-life/-/blob/master/LICENSE.md)
### [Code of Conduct](https://gitlab.com/a14m/game-of-life/-/blob/master/CODE_OF_CONDUCT.md)