Skip to content

Suggestion: List supported Zig versions in the README #18

Description

@KercyDing

Suggestion: List supported Zig versions in the README

Recently, while using some packages from allyourcodebase, I found that it’s sometimes difficult to quickly determine which Zig versions the current branch supports.

The build.zig.zon file usually includes a minimum_zig_version, but this only tells users the minimum requirement and doesn’t clearly show:

  • Which Zig releases the current branch is known to work with;
  • Whether it’s still compatible with slightly older Zig releases;
  • Whether it also works with Zig master.

I was wondering if it would make sense to add a small Zig compatibility / support section to each repository’s README, so this information is immediately visible.

I’m not suggesting that every repository should track Zig master. Since allyourcodebase targets the latest tagged Zig version, master could simply be optional and only listed when it is known to work.

I created a small SVG badge service as a prototype for this purpose:

https://github.com/KercyDing/zig-support

It embeds the supported versions directly into the URL path, for example:

[![Zig support](https://zig-support.dkx215417.workers.dev/master/0.16.0/0.15.2/badge.svg)](https://ziglang.org/download/)

Result:

Zig support

This way, when updating compatibility information, you only need to change the URL in the README.

I think this could make Zig compatibility much easier to understand at a glance and be helpful for users!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions