Readme update

kvark · Nov 11, 2023 · 44dc115 · 44dc115
1 parent 941b8be
commit 44dc115
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 32 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -7,40 +7,33 @@
 
 ![](logo.png)
 
-Blade is a low-level GPU library in Rust with the focus on ergonomics.
-It's unsafe, it's incomprehensive, but it's small, fast, and actually fun to prototype with!
+Blade is an innovative rendering solution for Rust. It starts with an ergonomic [low-level GPU abstraction](https://youtu.be/63dnzjw4azI?t=623), which is actually fun to play with. It then grows into a high-level rendering library that utilizes hardware ray-tracing. Finally, a [task-parallel asset pipeline](https://youtu.be/1DiA3OYqvqU) together with [egui](https://www.egui.rs/) support turn it into a minimal rendering engine.
+
+See [motivation](motivation.md), [FAQ](FAQ.md), and [performance](performance.md) for more info about the low-level API.
 
-See [motivation](motivation.md), [FAQ](FAQ.md), and [performance](performance.md) for more info.
-
 ![sponza scene](sponza.jpg)
 ![ray-query example](ray-query.gif)
+![scene editor](scene-editor.jpg)
 ![particles example](particles.png)
 
-## Platforms
-
-The backend is selected automatically based on the host platform.
-
-Vulkan:
-- Desktop Linux/Windows
-- Android
+## Instructions
 
-Metal:
-- Desktop macOS
-- iOS
+Just the usual :crab: workflow. E.g. to run the bunny-mark benchmark run:
+```bash
+cargo run --release --example bunnymark
+```
 
-OpenGL ES:
-- Web
+## Platforms
 
-## Instructions
+The backend is selected automatically based on the host platform:
+- *Vulkan* on desktop Linux, Windows, and Android
+- *Metal* on desktop macOS, and iOS
+- *OpenGL ES3* on the Web
 
-Check:
-```
-cargo check
-```
-Run the minimal example:
-```
-cargo run --example mini
-```
+| Feature | Vulkan | Metal | GLES |
+| ------- | ------ | ----- | ---- |
+| compute | :white_check_mark: | :white_check_mark: | |
+| ray tracing | :white_check_mark: | | |
 
 ### OpenGL ES
 
@@ -70,10 +63,3 @@ Vulkan backend can be forced on using "vulkan" config flag. Example invocation t
 ```bash
 RUSTFLAGS="--cfg vulkan" CARGO_TARGET_DIR=./target-vk cargo test
 ```
-
-## Features
-
-| Feature | Vulkan | Metal | GLES |
-| ------- | ------ | ----- | ---- |
-| compute | :white_check_mark: | :white_check_mark: | |
-| ray tracing | :white_check_mark: | | |
diff --git a/docs/logo.png b/docs/logo.png
diff --git a/docs/scene-editor.jpg b/docs/scene-editor.jpg
diff --git a/docs/sponza.jpg b/docs/sponza.jpg