From cd9b7b8606b65f984a7c2244f297542e0b9c161b Mon Sep 17 00:00:00 2001 From: Rukai Date: Sat, 11 May 2019 14:01:14 +1000 Subject: [PATCH] Document how to run example in readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0047d152e0..412b9132b3 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,14 @@ Supported platforms: ## Usage -This repository contains C-language examples that link to the native library targets and perform basic rendering and computation. You can test them with `make`. +This repository contains C-language examples that link to the native library targets and perform basic rendering and computation. +To run the C triangle example, install a C compiler + glfw 3, then run these commands at the root of the repo: +``` +rustup toolchain install nightly +cargo install cbindgen +make examples-native +cd examples/hello_triangle_c/build +./hello_triangle +``` The idiomatic Rust wrapper lives in https://github.com/gfx-rs/wgpu-rs and provides a number of more complex examples to get a feel of the API.