From 531f59c68d1a78648829d03a96c71782ac88e8d2 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Mon, 5 Sep 2022 21:28:07 -0700 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index bb40723..1b5bcba 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,24 @@ $ nix develop $ direnv allow ``` +## FAQ + +### Why is a Nightly Missing? + +There are two possible reasons: + +1. The Zig download JSON that is used to generate this overlay only shows +the latest _master_ release. It doesn't keep track of historical releases. +If this overlay wasn't running or didn't exist at the time of a release, +we could miss a day. This is why historical dates beyond a certain point +don't exist; they predate this overlay (or original overlays this derives +from). + +2. The official Zig CI only generates a master release if the CI runs +full green. During certain periods of development, a full day may go by +where the master branch of the Zig compiler is broken. In this scenario, +a master build (aka "nightly") is not built or released at all. + ## Thanks The `sources.json` file was originally from another Zig overlay repository