From 4902c5139a472980f54e494863e139cfb017d4ad Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Mon, 30 Sep 2024 10:57:10 -0700 Subject: [PATCH] docs/stdlib: clarify 0.4 vs main branch Signed-off-by: Stephen Gutekanst --- content/docs/stdlib.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/content/docs/stdlib.md b/content/docs/stdlib.md index 6abe437..38f7eae 100644 --- a/content/docs/stdlib.md +++ b/content/docs/stdlib.md @@ -13,9 +13,33 @@ The Mach standard library can be found at: [github.com/hexops/mach](https://gith Thanks to Zig's lazy code evaluation and lazy dependency fetching, you really only pay for the parts you use. -## Getting started +## Choosing your Mach version -Add the Mach dependency to your `build.zig.zon` file: +### 0.4 branch (not actively developed, but more stable) + +The 0.4 branch is what applications like [Pixi](https://github.com/foxnne/pixi) and games like `#lordofzero` (in the Discord) are using. It uses GLFW, WebGPU, and optionally the ECS. It is [no longer in development](https://discord.com/channels/996677443681267802/996688886216523907/1259736837648416829) however. + +To use this version, add the Mach dependency to your `build.zig.zon` file: + +
zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz
+
+ + +### main branch (actively developed, experimental/unstable) + +This branch is where active development is happening, we are removing GLFW and WebGPU in favor of our own packages ([more details](https://discord.com/channels/996677443681267802/996688886216523907/1259736837648416829)) which means it is not stable - or may not even run - on some OS. At the time of writing Sep 30th, Windows is relatively stable, Linux might work under Wayland, and macOS is not expected to work currently. + +To use this version, add the Mach dependency to your `build.zig.zon` file:
zig fetch --save https://pkg.machengine.org/mach/$LATEST_COMMIT.tar.gz
 
@@ -31,6 +55,8 @@ fetch('https://api.github.com/repos/hexops/mach/branches/main', { }); +## Using the dependency + Then make it importable by your code in `build.zig`, e.g.: ```zig