From 495c9b3c40660ff819f9579fc50a594f842dfbfa Mon Sep 17 00:00:00 2001 From: Timo de Kort Date: Mon, 22 Jul 2019 22:22:37 +0200 Subject: [PATCH] update running an example --- README.md | 35 ++++++++++++++++++++++++++++++----- 1 file changed, 30 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0f618d3f27..17edab1b0f 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,37 @@ This is an idiomatic Rust wrapper over [wgpu-native](https://github.com/gfx-rs/w ## Usage The library requires one of the following features enabled in order to run any of the examples: - - "vulkan" - - "metal" - - "dx12" - - "dx11" + - Vulkan + - Metal + - DirectX 12 (Dx12) + - DirectX 11 (Dx11) + - OpenGL (Gl) -These examples assume that necessary dependencies for the graphics backend are already installed. For more information about installation and usage, refer to the [Getting Started](https://github.com/gfx-rs/gfx/blob/master/info/getting_started.md) gfx-rs guide. +These examples assume that necessary dependencies for the graphics backend are already installed. + +### Running an example +All examples are located under the [examples](examples) directory. We are using the default syntax for running examples, as found in the [Cargo](https://doc.rust-lang.org/cargo/reference/manifest.html#examples) documentation. + +#### Cube +```bash +cargo run --example cube --features metal +cargo run --example cube --features vulkan +cargo run --example cube --features dx12 +cargo run --example cube --features dx11 +cargo run --example cube --features gl +``` + +#### Hello Compute +The "1", "2", "3", and "4" are arguments passed into the program. These arguments are used for the compute pipeline. +```bash +cargo run --example hello-compute --features metal 1 2 3 4 +cargo run --example hello-compute --features vulkan 1 2 3 4 +cargo run --example hello-compute --features dx12 1 2 3 4 +cargo run --example hello-compute --features dx11 1 2 3 4 +cargo run --example hello-compute --features gl 1 2 3 4 +``` + +More examples can be found under the [examples](examples) directory. ## Friends