1
0
Fork 0
mirror of https://github.com/zigzap/zap.git synced 2025-10-20 15:14:08 +00:00

Update README.md to point out even more prominently the zig master situation

This commit is contained in:
Rene Schallner 2024-01-31 07:23:40 +01:00 committed by Rene Schallner
parent 39ee26f9a4
commit 4f2a326948

View file

@ -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.