summaryrefslogtreecommitdiffstats
path: root/CLI/rust/README.md
diff options
context:
space:
mode:
authora14m <[email protected]>2020-12-15 14:18:57 +0100
committera14m <[email protected]>2020-12-15 14:56:31 +0100
commit009e3b7441fd05cb4a1321b42e9af4b1df2ce0bd (patch)
treecfd714f90bfcd8a14f35e8624e1e59edb22ad60b /CLI/rust/README.md
parent9b0bce6583ea400cea7bcb90cd2da50edd0db3ac (diff)
Create README
Diffstat (limited to 'CLI/rust/README.md')
-rw-r--r--CLI/rust/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/CLI/rust/README.md b/CLI/rust/README.md
new file mode 100644
index 0000000..a66324d
--- /dev/null
+++ b/CLI/rust/README.md
@@ -0,0 +1,32 @@
+# 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
+TBD
+
+## Linting
+TBD
+
+## Testing
+TBD
+
+## Documentation
+TBD
+
+## 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)