updated readme

This commit is contained in:
andy 2021-06-21 23:31:56 +01:00
parent b52ca7d6c1
commit 38e3d25b01
2 changed files with 19 additions and 3 deletions

View File

@ -1,5 +1,5 @@
[package]
name = "game-of-life"
name = "gameoflife"
version = "0.1.0"
authors = ["aj <andrewjpack@gmail.com>"]
edition = "2018"

View File

@ -1,4 +1,20 @@
Game of Life
============
===============
## [Try it Out!](https://sarsoo.github.io/game-of-life/)
WASM-based game of life following the [Rust WASM book](https://rustwasm.github.io/docs/book/introduction.html) tutorial.
Rust WASM module for game logic with a JS frontend for rendering and processing user input.
## Building
1. Setup a Rust + wasm-pack environment and a Node environment
2. Build the Rust library into a WASM module
- `wasm-pack build`
3. Move to the Js workspace
- `cd www`
4. Install the Js dependencies
- `npm install`
5. Build the Js frontend with Rust WASM module
- `npm run build`