diff options
| -rw-r--r-- | CONTRIBUTING.md | 14 | ||||
| -rw-r--r-- | README.md | 25 |
2 files changed, 26 insertions, 13 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21b98ac..64b308e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,10 +34,9 @@ No mistake is too small. The Ziglings must be perfect. :-) If you have ideas for new lessons or a way Ziglings could be improved, don't hesitate to file an issue. -I prefer to write the bulk of the content myself at this time -(part of the reason I'm building Ziglings is to learn Zig -myself!), but I'm always open to ideas. - +Feel free to submit new exercises but please understand that they +may be heavily edited or rejected entirely if we feel they don't +fit for one reason or another. ## Platforms and Zig Versions @@ -50,7 +49,7 @@ downloads page. If you run into an error in Ziglings caused by breaking changes in the latest development build of Zig, that's a new bug in -Ziglings. Please file an issue...or make a pull request! +Ziglings. Please file an issue...or make a pull request! ## Formatting @@ -71,9 +70,8 @@ interface. Specifically: * When your changes are ready for review, push your branch: `git push origin my-branch` * Create a pull request from your branch to `ziglings/main` -* Your faithful Ziglings maintainer "ratfactor" (that's me!) will - take a look at your request ASAP (we don't talk about May-July - 2022, LOL) +* Your faithful Ziglings maintainers will take a look at your + request ASAP (we don't talk about May-July 2022, LOL) * Once the changes are reviewed, your request will be merged and eternal Ziglings contributor glory is yours! @@ -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. |