aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorDave Gauer <dave@ratfactor.com>2023-04-23 19:12:15 -0400
committerDave Gauer <dave@ratfactor.com>2023-04-23 19:12:15 -0400
commit346e6b00cd94cf9bac5b46b5e16724c64dcd4bb2 (patch)
tree8b336b7d56fecae8f214186d33cb45d201dfc857 /README.md
parent42c430a0c070fe7b73598fbacc6b0d1aad085390 (diff)
Updated README and CONTRIBUTING to reflect reality
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 20 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4d3f4a7..09b7297 100644
--- a/README.md
+++ b/README.md
@@ -140,11 +140,23 @@ zig build -Dn=19 -l
## What's Covered
-I've decide to limit Ziglings to the core language and not
-attempt coverage of the Standard Library. Perhaps you can change
-my mind?
+The primary goal for Ziglings is to cover the core Zig language.
-Core Language
+It would be nice to cover the Standard Library as well, but this
+is currently challenging because the stdlib is evolving even
+faster than the core language (and that's saying something!).
+Not only would stdlib coverage change very rapidly, some exercises might even cease to be relevant entirely.
+
+Having said that, there are some stdlib features that are probably here
+to stay or are so important to understand that they are worth the
+extra effort to keep current.
+
+Conspicuously absent from Ziglings are a lot of string
+manipulation exercises. This is because Zig itself largely avoids
+dealing with strings. Hopefully there will be an obvious way to
+address this in the future. The Ziglings crew loves strings!
+
+Zig Core Language
* [x] Hello world (main needs to be public)
* [x] Importing standard library
@@ -178,6 +190,9 @@ Core Language
* [x] Anonymous structs/tuples/lists
* [ ] Async <--- IN PROGRESS!
* [X] Interfaces
+
+Zig Standard Library
+
* [X] Working with C
* [X] String formatting
* [X] Bit manipulation
@@ -189,7 +204,7 @@ the learning resource I wished for. There will be tons of room for improvement:
* Wording of explanations
* Idiomatic usage of Zig
-* Maybe additional exercises?
+* Additional exercises
Please see [CONTRIBUTING](https://github.com/ratfactor/ziglings/blob/main/CONTRIBUTING.md) in this repo for the full details.