README: update example command, document where to find examples

Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2022-10-16 13:34:15 -07:00
parent 96a9c94922
commit 1eba5906ae

View file

@ -17,15 +17,19 @@ Written in [Zig](https://ziglang.org/), Mach is for creating games, graphical ap
## Cross-platform graphics in ~60 seconds ## Cross-platform graphics in ~60 seconds
```sh ```sh
git clone https://github.com/hexops/mach git clone --recursive https://github.com/hexops/mach-examples
cd mach/ cd mach-examples/
zig build run-example-boids zig build run-boids
``` ```
Cross-platform graphics, a unified shader language & compute shaders. Cross-platform graphics, a unified shader language & compute shaders.
(Requires [zig 0.10.x](https://ziglang.org/) | [known issues](https://github.com/hexops/mach/blob/main/doc/known-issues.md#known-issues)) (Requires [zig 0.10.x](https://ziglang.org/) | [known issues](https://github.com/hexops/mach/blob/main/doc/known-issues.md#known-issues))
## Get started with 15+ examples
* Examples showcase: https://machengine.org/gpu/
## Libraries ## Libraries
Mach has many libraries you can use for game development in Zig - **you don't have to use the entire engine.** All our libraries aim to have the same zero-fuss installation, cross compilation, and platform support: Mach has many libraries you can use for game development in Zig - **you don't have to use the entire engine.** All our libraries aim to have the same zero-fuss installation, cross compilation, and platform support: