From 4f2a32694837106100c367b9356c2292c8bfbd45 Mon Sep 17 00:00:00 2001 From: Rene Schallner <30892199+renerocksai@users.noreply.github.com> Date: Wed, 31 Jan 2024 07:23:40 +0100 Subject: [PATCH] Update README.md to point out even more prominently the zig master situation --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9114aed..83384e4 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ Exactly the goals I set out to achieve! ## Most FAQ: +### Zap uses the latest stable zig release (0.11.0) for a reason. So you don't have to keep up with frequent breaking changes. It's an "LTS feature". If you want to use zig master, use the `zig-0.12.0` branch but be aware that I don't provide `build.zig.zon` snippets or tagged releases for it for the time being. If you know what you are doing, that shouldn't stop you using it with zig master though. + - Q: **Where is the API documentation?** - A: Docs are a work in progress. You can check them out [here](https://zigzap.org/zap). The docs are based on the `zig-0.12.0` branch but apply to the current release (zig 0.11.0), too. - A: Run `zig build run-docserver` to serve them locally.