update readme
This commit is contained in:
parent
998b7747e9
commit
85e708b317
1 changed files with 20 additions and 0 deletions
20
README.md
20
README.md
|
@ -5,6 +5,13 @@ A small [wgpu](https://github.com/gfx-rs/wgpu) renderer written in [Rust](https:
|
|||
## Try it out
|
||||
[rasanen.dev/wgpu-renderer](https://rasanen.dev/wgpu-renderer)
|
||||
|
||||
Controls:
|
||||
- WASD - Move horizontally
|
||||
- Ctrl/Space - Move vertically
|
||||
- Mouse - Look around
|
||||
- Scrollwheel - Increase/Decrease movement speed
|
||||
- ESC - Quit (Only on standalone version)
|
||||
|
||||
## Features
|
||||
|
||||
- Physically based shading
|
||||
|
@ -28,6 +35,19 @@ TODO:
|
|||
- Immediate mode UI (dear imgui, egui)
|
||||
- Some type of GI (DDGI, VXGI)
|
||||
|
||||
## Running locally
|
||||
|
||||
Standalone:
|
||||
```sh
|
||||
cargo run --release
|
||||
```
|
||||
|
||||
WASM requires [miniserve](https://github.com/svenstaro/miniserve), or some other http server, such as `python3 -m http.server`.
|
||||
For miniserve, see:
|
||||
```sh
|
||||
./run-wasm.sh
|
||||
```
|
||||
|
||||
## References
|
||||
- [wgpu examples](https://github.com/gfx-rs/wgpu/blob/master/wgpu/examples)
|
||||
- [Learn Wgpu](https://sotrh.github.io/learn-wgpu/)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue