2021-02-27 14:51:15 -05:00
|
|
|
# Ziglings
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-02-27 14:51:15 -05:00
|
|
|
Welcome to Ziglings! This project contains a series of tiny broken programs.
|
2021-02-13 11:23:53 -05:00
|
|
|
By fixing them, you'll learn how to read and write
|
2020-12-23 12:02:35 -05:00
|
|
|
[Zig](https://ziglang.org/)
|
2021-02-15 20:04:18 -05:00
|
|
|
code.
|
|
|
|
|
2021-02-27 14:51:15 -05:00
|
|
|
![ziglings](https://user-images.githubusercontent.com/1458409/109398392-c1069500-790a-11eb-8ed4-7d7d74d32666.jpg)
|
|
|
|
|
|
|
|
Those tiny broken programs need your help! (You'll also save the planet from
|
|
|
|
evil aliens and help some friendly elephants stick together, which is very
|
|
|
|
sweet of you.)
|
2020-12-23 12:02:35 -05:00
|
|
|
|
|
|
|
This project was directly inspired by the brilliant and fun
|
|
|
|
[rustlings](https://github.com/rust-lang/rustlings)
|
|
|
|
project for the [Rust](https://www.rust-lang.org/) language.
|
2021-03-10 14:47:23 -05:00
|
|
|
Indirect inspiration comes from [Ruby Koans](http://rubykoans.com/)
|
2021-02-13 15:47:00 -05:00
|
|
|
and the Little LISPer/Little Schemer series of books.
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-02-06 09:29:49 -05:00
|
|
|
## Intended Audience
|
|
|
|
|
2021-02-06 15:54:56 -05:00
|
|
|
This will probably be difficult if you've _never_ programmed before.
|
|
|
|
But no specific programming experience is required. And in particular,
|
|
|
|
you are _not_ expected to have any prior experience with "systems programming"
|
|
|
|
or a "systems" level language such as C.
|
2021-02-06 09:29:49 -05:00
|
|
|
|
|
|
|
Each exercise is self-contained and self-explained. However, you're encouraged
|
|
|
|
to also check out these Zig language resources for more detail:
|
|
|
|
|
|
|
|
* https://ziglearn.org/
|
|
|
|
* https://ziglang.org/documentation/master/
|
|
|
|
|
2021-03-10 14:47:23 -05:00
|
|
|
Also, the [Zig community](https://github.com/ziglang/zig/wiki/Community) is incredibly friendly and helpful!
|
|
|
|
|
2020-12-23 12:02:35 -05:00
|
|
|
## Getting Started
|
|
|
|
|
2021-02-15 20:04:18 -05:00
|
|
|
Install a [development build](https://ziglang.org/download/) of the Zig compiler.
|
|
|
|
(See the "master" section of the downloads page.)
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-02-15 20:13:50 -05:00
|
|
|
Verify the installation and build number of `zig` like so:
|
2020-12-23 12:02:35 -05:00
|
|
|
|
|
|
|
```bash
|
|
|
|
$ zig version
|
2021-12-20 14:43:51 -05:00
|
|
|
0.9.0-dev.2025+xxxxxxxxx
|
2020-12-23 12:02:35 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
Clone this repository with Git:
|
|
|
|
|
|
|
|
```bash
|
2021-02-14 16:42:42 -05:00
|
|
|
$ git clone https://github.com/ratfactor/ziglings
|
|
|
|
$ cd ziglings
|
2020-12-23 12:02:35 -05:00
|
|
|
```
|
|
|
|
|
2021-02-11 23:04:36 -05:00
|
|
|
Then run `zig build` and follow the instructions to begin!
|
2020-12-23 12:02:35 -05:00
|
|
|
|
|
|
|
```bash
|
2021-02-14 16:42:42 -05:00
|
|
|
$ zig build
|
2020-12-23 12:02:35 -05:00
|
|
|
```
|
|
|
|
|
2021-02-14 16:42:42 -05:00
|
|
|
## A Note About Versions
|
2021-02-12 22:53:07 -05:00
|
|
|
|
2021-02-15 20:04:18 -05:00
|
|
|
The Zig language is under very active development. In order to be current,
|
2021-02-15 20:13:50 -05:00
|
|
|
Ziglings tracks **development** builds of the Zig compiler rather than
|
2021-12-20 14:43:51 -05:00
|
|
|
versioned **release** builds. The last stable release was `0.8.1`, but Ziglings
|
2021-06-14 10:45:32 -04:00
|
|
|
needs a dev build with pre-release version "0.9.0" and a build number at least
|
2021-02-15 20:13:50 -05:00
|
|
|
as high as that shown in the example version check above.
|
2021-02-14 19:25:35 -05:00
|
|
|
|
|
|
|
It is likely that you'll download a build which is _greater_ than the minimum.
|
2021-02-12 22:53:07 -05:00
|
|
|
|
2021-12-20 14:49:25 -05:00
|
|
|
_(For those who cannot easily update Zig, there are also community-supported
|
|
|
|
branches in this repo. At the moment, there's one for v0.8.1. Older version
|
|
|
|
branches may or may not have all exercises and/or bugfixes.)_
|
|
|
|
|
2021-02-15 20:04:18 -05:00
|
|
|
Once you have a build of the Zig compiler that works with Ziglings, they'll
|
|
|
|
continue to work together. But keep in mind that if you update one, you may
|
2021-02-14 19:25:35 -05:00
|
|
|
need to also update the other.
|
2021-02-12 22:53:07 -05:00
|
|
|
|
2021-06-30 17:30:01 -04:00
|
|
|
Also note that the current "stage 1" Zig compiler is very strict
|
|
|
|
about input:
|
2021-06-30 17:33:38 -04:00
|
|
|
[no tab characters or Windows CR/LF newlines are allowed](https://github.com/ziglang/zig/issues/544).
|
2021-06-30 17:30:01 -04:00
|
|
|
|
2021-04-21 09:47:16 -04:00
|
|
|
### Version Changes
|
|
|
|
|
2021-12-20 14:43:51 -05:00
|
|
|
* 2021-12-20 0.9.0-dev.2025 - `c_void` is now `anyopaque`
|
2021-06-14 10:45:32 -04:00
|
|
|
* 2021-06-14 0.9.0-dev.137 - std.build.Id `.Custom` is now `.custom`
|
|
|
|
* 2021-04-21 0.8.0-dev.1983 - std.fmt.format() `any` format string required
|
|
|
|
* 2021-02-12 0.8.0-dev.1065 - std.fmt.format() `s` (string) format string required
|
2021-04-21 09:47:16 -04:00
|
|
|
|
2021-02-14 16:42:42 -05:00
|
|
|
## Advanced Usage
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-02-14 16:42:42 -05:00
|
|
|
It can be handy to check just a single exercise or _start_ from a single
|
|
|
|
exercise:
|
2020-12-23 12:02:35 -05:00
|
|
|
|
|
|
|
```bash
|
2021-02-14 16:42:42 -05:00
|
|
|
zig build 19
|
|
|
|
zig build 19_start
|
2020-12-23 12:02:35 -05:00
|
|
|
```
|
2021-02-14 16:42:42 -05:00
|
|
|
|
|
|
|
You can also run without checking for correctness:
|
|
|
|
|
2021-02-11 23:04:36 -05:00
|
|
|
```bash
|
2021-03-12 19:09:35 -05:00
|
|
|
zig build 19_test
|
2021-02-11 23:04:36 -05:00
|
|
|
```
|
|
|
|
|
2021-02-14 16:42:42 -05:00
|
|
|
Or skip the build system entirely and interact directly with the compiler
|
|
|
|
if you're into that sort of thing:
|
2021-02-11 23:04:36 -05:00
|
|
|
|
|
|
|
```bash
|
2021-03-12 19:09:35 -05:00
|
|
|
zig run exercises/001_hello.zig
|
2021-02-11 23:04:36 -05:00
|
|
|
```
|
|
|
|
|
2021-02-14 16:42:42 -05:00
|
|
|
Calling all wizards: To prepare an executable for debugging, install it
|
|
|
|
to zig-cache/bin with:
|
2021-02-11 23:04:36 -05:00
|
|
|
|
|
|
|
```bash
|
2021-03-12 19:09:35 -05:00
|
|
|
zig build 19_install
|
2021-02-11 23:04:36 -05:00
|
|
|
```
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-11-07 20:52:05 -05:00
|
|
|
## What's Covered
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-11-07 20:52:05 -05:00
|
|
|
I've decide to limit Ziglings to the core language and not
|
|
|
|
attempt coverage of the Standard Library. Perhaps you can change
|
|
|
|
my mind?
|
2020-12-23 12:02:35 -05:00
|
|
|
|
2021-04-30 21:35:56 -04:00
|
|
|
Core Language
|
|
|
|
|
2021-01-03 12:21:11 -05:00
|
|
|
* [x] Hello world (main needs to be public)
|
|
|
|
* [x] Importing standard library
|
2021-01-03 18:55:45 -05:00
|
|
|
* [x] Assignment
|
2021-01-03 20:34:26 -05:00
|
|
|
* [x] Arrays
|
2021-01-05 19:26:02 -05:00
|
|
|
* [x] Strings
|
2021-01-08 17:53:22 -05:00
|
|
|
* [x] If
|
2021-01-10 11:46:42 -05:00
|
|
|
* [x] While
|
2021-01-18 19:21:18 -05:00
|
|
|
* [x] For
|
2021-01-22 17:42:03 -05:00
|
|
|
* [x] Functions
|
2021-02-03 19:19:31 -05:00
|
|
|
* [x] Errors (error/try/catch/if-else-err)
|
|
|
|
* [x] Defer (and errdefer)
|
2021-01-31 17:48:34 -05:00
|
|
|
* [x] Switch
|
2021-02-03 19:19:31 -05:00
|
|
|
* [x] Unreachable
|
2021-02-06 09:29:49 -05:00
|
|
|
* [x] Enums
|
2021-02-08 20:35:28 -05:00
|
|
|
* [x] Structs
|
|
|
|
* [x] Pointers
|
2021-02-16 20:28:34 -05:00
|
|
|
* [x] Optionals
|
2021-02-28 13:23:22 -05:00
|
|
|
* [x] Struct methods
|
2021-03-06 21:31:55 -05:00
|
|
|
* [x] Slices
|
2021-03-13 16:27:14 -05:00
|
|
|
* [x] Many-item pointers
|
2021-03-09 20:04:43 -05:00
|
|
|
* [x] Unions
|
2021-04-10 11:39:11 -04:00
|
|
|
* [x] Numeric types (integers, floats)
|
|
|
|
* [x] Labelled blocks and loops
|
|
|
|
* [x] Loops as expressions
|
2021-04-11 11:22:38 -04:00
|
|
|
* [x] Builtins
|
2021-04-30 21:35:56 -04:00
|
|
|
* [x] Inline loops
|
|
|
|
* [x] Comptime
|
2021-05-06 20:32:36 -04:00
|
|
|
* [x] Sentinel termination
|
2021-05-09 13:10:09 -04:00
|
|
|
* [x] Quoted identifiers @""
|
2021-05-09 19:53:14 -04:00
|
|
|
* [x] Anonymous structs/tuples/lists
|
2021-11-07 20:52:05 -05:00
|
|
|
* [ ] Async <--- IN PROGRESS!
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
Contributions are very welcome! I'm writing this to teach myself and to create
|
|
|
|
the learning resource I wished for. There will be tons of room for improvement:
|
|
|
|
|
|
|
|
* Wording of explanations
|
|
|
|
* Idiomatic usage of Zig
|
|
|
|
* Maybe additional exercises?
|
|
|
|
|
|
|
|
Please see CONTRIBUTING.md in this repo for the full details.
|
|
|
|
|
|
|
|
|