ziglings/README.md
2021-01-03 18:55:45 -05:00

2.1 KiB

ziglings

Welcome to ziglings. This project contains a series of incomplete exercises. By completing the exercises, you learn how to read and write Zig code.

This project was directly inspired by the brilliant and fun rustlings project for the Rust language.

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 of the Zig compiler.

Verify the installation and version of zig like so:

$ zig version
0.7.1+<some hexadecimal string>

Clone this repository with Git:

git clone https://github.com/ratfactor/ziglings
cd ziglings

Then run the ziglings script and follow the instructions to begin!

./ziglings

Manual Usage

If you can't (or don't want to) use the script, you can manually verify each exercise with the Zig compiler:

zig run exercises/01_hello.zig

TODO

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
  • Additional exercises
  • Re-write the ziglings script using the Zig build system (???)

Planned exercises:

  • Hello world (main needs to be public)
  • Importing standard library
  • Assignment
  • Arrays
  • If
  • While
  • For
  • Functions
  • Defer
  • Errors
  • Switch
  • Runtime safety
  • Unreachable
  • Pointers
  • Pointer sized integers
  • Multi pointers
  • Slices
  • Enums
  • Structs
  • Unions
  • Integer rules
  • Floats
  • Labelled blocks
  • Labelled loops
  • Loops as expressions
  • Optionals
  • Comptime
  • Inline loops
  • Anonymous structs
  • Sentinel termination
  • Vectors
  • Imports

The initial topics for these exercises were unabashedly cribbed from ziglearn.org.