From 85e708b317dbb095624495bb6e34e1c67dcc40db Mon Sep 17 00:00:00 2001 From: nullprop Date: Sat, 28 Jan 2023 13:24:06 +0200 Subject: [PATCH] update readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index ccf4ee1..29166da 100644 --- a/README.md +++ b/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/)