Added readme

2021-04-21 23:14:38 +05:00 · 2021-04-21 23:14:38 +05:00 · 20f9756d4f
commit 20f9756d4f
parent 1bce88794d
1 changed files with 19 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,19 @@
+# Conway's Game of Life
+
+## Application and dev stack overview
+
+It is a Conway's game of life implementation with JavaScript in browser. TypeScript is used for static type checking and esbuild for bundling.
+
+## Running instructions
+
+```bash
+# Build
+npm install
+npm run build
+
+# Open in browser
+chromium index.html
+
+# With webserver
+npx serve -s .
+```