This repo proposes README.md badges for open source Zig projects to indicate what Zig version(s) the project intends to support. This enables users to make informed decisions when adopting and contributing to a Zig project.
Zig is continously changing, often with breakages, which makes depending on another Zig project a risky and often confusing endeaver. This adds friction to the open source community as it's hard to depend on one another when everyone is dealing with changes in their own time (or maybe never).
A badge in projects README.md doesn't solve the underlying work required to maintain a zig project but will clearly document the intent of the maintainers so dependants can make informed decisions.
Hopefully one day this will be irrelevant and Zig will be truly stable, where every project supports "zig" (which implicitly means 1.x.x) but it's not there yet, and Zig projects and the community need to exist in the meantime to help test and shape Zigs future.
View source to see the markdown used
| Example | Kind |
|---|---|
 |
Supports a single fixed version |
 |
Supports the latest under development version (i.e., the future versions) |
 |
Supports multiple fixed versions |
 |
Supports all within the patch range |
 |
Supports all within the minor range |
 |
Supports a minimum version |
 |
Supports a minimum to maximum range |
 |
Experimental, no guarantees to support any version |
 |
Supports every version, tell them you're dreamin' |
These badges are rendered by shields.io - go check them out and offer support if feasible.