Add README

This commit is contained in:
Yash Karandikar 2021-11-28 11:30:45 -06:00
parent c29a6c3c4d
commit 42feb9d50d
Signed by: karx
GPG key ID: A794DA2529474BA5

23
drawrs/README.md Normal file
View file

@ -0,0 +1,23 @@
# DrawRS
[Live App](https://etc.karx.xyz/rgl/drawrs/)
## Running Locally
1. Install dependencies
First, install `rust` from [the Rust website](https://www.rust-lang.org/). Then, install `trunk`:
```bash
cargo install --locked trunk
```
This project requires `rustc` version `1.56.0` because it uses the 2021 edition of Rust!
2. Build project
```bash
cd /path/to/drawrs
trunk serve
```
3. Open in browser
[Check the supported browser list](https://rustwasm.github.io/docs/wasm-bindgen/reference/browser-support.html) and open https://localhost:8080 in one of the supported browsers.
<small>Created using [Sycamore](https://crates.io/crates/sycamore) and Rust with WebAssembly</small>