Skip to content

Commit acdfab3

Browse files
committed
Update README.md
1 parent 8396e6f commit acdfab3

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,18 @@
33
`rust-gpu` helper program for automating shader crate compilation.
44

55
Can compile once, or run in daemon mode and recompile in response to filesystem changes.
6+
7+
## Usage
8+
9+
`rust-gpu-builder` relies on the `spirv-builder` crate, which in turn relies on the cargo ecosystem
10+
to configure the appropriate nightly toolchain for `rust-gpu`. As such, it needs to be run from inside a workspace via `cargo run`.
11+
12+
Thus, it's recommended to add `rust-gpu-builder` as a a git submodule of your cargo workspace, and set it up as the default binary target.
13+
14+
### One-shot compilation
15+
16+
`cargo run --release -- <path-to-shader-crate>` will compile the provided shader crate and output `<crate-name>.spv` and `<crate-name>.spv.json` to `target/spirv-unknown-spv1.5/release/deps/`.
17+
18+
### Hot-recompile
19+
20+
`cargo run --release -- <path-to-shader-crate> -w <path-to-watch>` will compile as per the above, then watch the provided path and recompile whenever it changes.

0 commit comments

Comments
 (0)