Add README

This commit is contained in:
Yash Karandikar 2021-12-11 11:51:54 -06:00
parent b3e2d8f5fa
commit 09618b57fd
Signed by: karx
GPG key ID: A794DA2529474BA5
3 changed files with 34 additions and 0 deletions

22
riddlrs/README.md Normal file
View file

@ -0,0 +1,22 @@
# RiddlRS
[Live App](https://etc.karx.xyz/rgl/riddlrs/)
## 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/riddlrs
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>

View file

@ -332,6 +332,9 @@ fn main() {
AppMode::Startscreen => view! { StartScreen(Props { mode: cloned!(mode => mode), errors: cloned!(errors => errors), time_elapsed: cloned!(time_elapsed => time_elapsed) }) }
})
}
div(class="footer") {
"Powered by Rust 1.56 and WASM"
}
}
});
}

View file

@ -29,4 +29,13 @@
.card + .card {
margin-left: .75rem;
}
.footer {
position: fixed;
left: 0;
bottom: 0;
width: 100%;
text-align: center;
margin-bottom: 10px;
}