summaryrefslogtreecommitdiffstats
path: root/CLI/rust/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'CLI/rust/README.md')
-rw-r--r--CLI/rust/README.md15
1 files changed, 10 insertions, 5 deletions
diff --git a/CLI/rust/README.md b/CLI/rust/README.md
index 471ea5d..f5a1ffa 100644
--- a/CLI/rust/README.md
+++ b/CLI/rust/README.md
@@ -3,7 +3,9 @@
The implementation of the [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life) rust package
## Installation
-TBD
+```bash
+$ cargo install terminal_game_of_life
+```
## Usage
@@ -55,9 +57,12 @@ Run `cargo +nightly test`
Run `cargo doc`
## Release
-TBD
+- Update the [version](./Cargo.toml) number
+- Run `cargo build --release` and commit changes
+- Update the [CHANGELOG](./CHANGELOG.md)
+- Create a git tag `rust/v#{version_number}` ex: `rust/v0.1.1-pre`
## 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)
+### [Contributing](../../CONTRIBUTING.md)
+### [License](../../LICENSE.md)
+### [Code of Conduct](../../CODE_OF_CONDUCT.md)