From 7023b5345c4fc29aa58aebf47d1968c466da30e2 Mon Sep 17 00:00:00 2001 From: Dave Gauer Date: Fri, 12 Feb 2021 22:53:07 -0500 Subject: [PATCH] Update README to reflect new version checking --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f560284..616e3d8 100644 --- a/README.md +++ b/README.md @@ -24,16 +24,13 @@ to also check out these Zig language resources for more detail: ## Getting Started -_Note: This currently uses a shell (Bash) script to automate the "game". A -future update may remove this requirement. See TODO below._ - -Install the [master release](https://ziglang.org/download/) of the Zig compiler. +Install a [master build](https://ziglang.org/download/) of the Zig compiler. Verify the installation and version of `zig` like so: ```bash $ zig version -0.7.1+ +0.8.0-dev.1065+ ``` Clone this repository with Git: @@ -49,6 +46,19 @@ Then run `zig build` and follow the instructions to begin! zig build ``` +## A Note About Compiler Versions + +The Zig language is under very active development. Ziglings will attempt to +be current, but not bleeding-edge. However, sometimes fundamental changes +will happen. Ziglings will check for a minimum version and build number +(which is this one: `0.x.x-dev.`) and exit if your version of +Zig is too old. It is likely that you'll download a build which is greater +than the number in the example shown above in this README. That's okay! + +Once you have a version of the Zig compiler that works with your copy of +Ziglings, they'll continue to work together forever. But if you update one, +keep in mind that you may need to also update the other. + ## Manual Usage If you want to run a single file for testing, you can do so with this command: