aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Gauer <dave@ratfactor.com>2021-02-12 22:53:07 -0500
committerDave Gauer <dave@ratfactor.com>2021-02-12 22:53:07 -0500
commit8133b22be1d51589771df40e8d5e4bc2f3ba3b8e (patch)
tree48dc67725fe5caaf8ab0fd70c8aa1e7786aa6aa6 /README.md
parente2c12aa8ba829669aba07fe41d4106bf7207de2b (diff)
downloadziglings-8133b22be1d51589771df40e8d5e4bc2f3ba3b8e.tar.gz
ziglings-8133b22be1d51589771df40e8d5e4bc2f3ba3b8e.tar.bz2
ziglings-8133b22be1d51589771df40e8d5e4bc2f3ba3b8e.tar.xz
ziglings-8133b22be1d51589771df40e8d5e4bc2f3ba3b8e.zip
Update README to reflect new version checking
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files 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+<some hexadecimal string>
+0.8.0-dev.1065+<some hexadecimal string>
```
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.<build number>`) 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: