Add readme

This commit is contained in:
Yash Karandikar 2021-11-23 16:37:05 -06:00
parent 66773cf58f
commit 68ce71f61e
Signed by: karx
GPG key ID: A794DA2529474BA5
3 changed files with 35 additions and 0 deletions

23
typers/README.md Normal file
View file

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

@ -257,6 +257,9 @@ fn main() {
AppMode::Restart => template! { RestartView(cloned!((mode, stats) => Props { mode, stats })) },
})
}
div(class="footer") {
"Powered by Rust 1.56 and WASM"
}
}
});
}

View file

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