p6nj/typonomy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update README with quick description

Browse source
This commit is contained in:
Ponj 2024-11-15 18:06:41 -05:00
parent 6026d434ac
commit 8e47f6570f
Signed by: p6nj
GPG key ID: 6FED68D87C479A59
1 changed files with 6 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,20 +1,9 @@
Example of how you can compile Bevy to WASM and run it on Shuttle.
# Typonomy :D
## Instructions
Quizz time! Typonomy is a Rust type guessing game.
Make sure you have `wasm-bindgen-cli` and the rustup `wasm32-unknown-unknown` compilation target added. If you don't, you can get them by running the following:
```bash
cargo install wasm-bindgen-cli
rustup target add wasm32-unknown-unknown
Visit the [official website](https://typonomy-eoe6.shuttle.app/) or run it locally with [`shuttle`](https://docs.shuttle.dev/getting-started/installation) :
```sh
shuttle run --release
```
You can try the example out by simply running `cargo run`, or go straight to compilation if you want to get your game straight to the browser.
In the Makefile, there is a command for compiling the game to WASM.
If you don't have `make` installed, you can run the command manually.
```bash
make build
```
Go to the project workspace root or the `server` folder, run `shuttle run`, then visit `http://localhost:8000/game`, you should see your Bevy program in action!