aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Gauer <[email protected]>2021-02-14 19:25:35 -0500
committerDave Gauer <[email protected]>2021-02-14 19:25:35 -0500
commit4b8cb2e44499bbde3ef10846cafffbe0cb1c1fb3 (patch)
treefdfe0e857ccc5202d1c79a90f98d1fba3d73cc8d /README.md
parent03a09639c6aee07c5958e22b42a83172abc7984e (diff)
downloadziglings-4b8cb2e44499bbde3ef10846cafffbe0cb1c1fb3.tar.xz
ziglings-4b8cb2e44499bbde3ef10846cafffbe0cb1c1fb3.zip
Attempt to make the version error and README clearer (#14)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index 627cd1a..fd40c72 100644
--- a/README.md
+++ b/README.md
@@ -32,7 +32,7 @@ Verify the installation and version of `zig` like so:
```bash
$ zig version
-0.8.0-dev.1065+<some hexadecimal string>
+0.8.0-dev.1065+xxxxxxxxx
```
Clone this repository with Git:
@@ -52,14 +52,15 @@ $ zig build
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!
+will happen. Ziglings will check for a minimum version and build number.
+
+(See Getting Started above for the current minimum.)
+
+It is likely that you'll download a build which is _greater_ than the minimum.
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.
+Ziglings, they'll continue to work together. But if you update one, you may
+need to also update the other.
## Advanced Usage