From af6e2fc7ab3296b71f9472d8fe85ab91a3e72abe Mon Sep 17 00:00:00 2001 From: Hiroaki Yutani Date: Wed, 4 May 2022 11:11:07 +0900 Subject: [PATCH] Describe the usage of `cargo run` --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8421326d7e..fbaa063d7d 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,12 @@ naga my_shader.spv my_shader.metal --flow-dir flow-dir # convert the SPV to Meta naga my_shader.wgsl my_shader.vert --profile es310 # convert the WGSL to GLSL vertex stage under ES 3.20 profile ``` +As naga includes a default binary target, you can also use `cargo run` without installation. This is useful when you develop naga itself, or investigate the behavior of naga at a specific commit (e.g. [wgpu](https://github.com/gfx-rs/wgpu) might pin a different version of naga than the `HEAD` of this repository). + +```bash +cargo run my_shader.wgsl +``` + ## Development workflow The main instrument aiding the development is the good old `cargo test --all-features --workspace`,