From 42feb9d50d1cbe88bf05a7df7297cc9d88a324e9 Mon Sep 17 00:00:00 2001 From: Yash Karandikar Date: Sun, 28 Nov 2021 11:30:45 -0600 Subject: [PATCH] Add README --- drawrs/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 drawrs/README.md diff --git a/drawrs/README.md b/drawrs/README.md new file mode 100644 index 0000000..fec8fc3 --- /dev/null +++ b/drawrs/README.md @@ -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. + + +Created using [Sycamore](https://crates.io/crates/sycamore) and Rust with WebAssembly