aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e9517c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Game of life
+
+The code is written in Rust and is compiled to WebAssembly.
+[wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) is used to interact
+with JavaScript.
+
+See [the wikipedia page](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life)
+to get more information about game of life.
+
+## Live
+
+[https://guyonvarch.gitlab.io/game-of-life](https://guyonvarch.gitlab.io/game-of-life)
+
+## Getting started
+
+```bash
+nix-shell --run ./watch
+```
+
+## Deploy
+
+```bash
+nix-shell --run ./deploy
+```