Skip to content

Commit c2fc94e

Browse files
committed
docs: clarify Zig version support and update installation notes
- Explain that the package builds against all supported stable Zig versions - Advise against using Zig nightly due to unstable build-system API - Correct grammar and update listed versions in installation instructions This helps users avoid build issues and improves guidance for installation.
1 parent 7129519 commit c2fc94e

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,13 @@ Like `zig build run_minimal`, this will build and run the `minimal` example.
5959

6060
## Installation
6161

62-
> note: for `0.13.0` and previous version, please use tag `2.5.0-beta.2`
62+
> note: for `0.13.0` and previous versions, please use tag `2.5.0-beta.2`
6363
64-
### Zig `0.14.0` \ `0.15.1`
64+
### Zig `0.14.0` / `0.15.1` / `0.16.0`
6565

66-
> To be honest, I don’t recommend using the nightly version because the API of the build system is not yet stable, which means that there may be problems with not being able to build after nightly is updated.
66+
The same package builds against every supported stable Zig release. Nightly is
67+
still not recommended — the build-system API can change between dev builds
68+
and break the binding without warning.
6769

6870
1. Add to `build.zig.zon`
6971

0 commit comments

Comments
 (0)