Zig Cookbook

Zig cookbook is a collection of simple Zig programs that demonstrate good practices to accomplish common programming tasks.

  • Main branch tracks Zig 0.13.0 and master, and ensured on Linux and macOS via GitHub actions.
  • Zig 0.11.0 support can be found in here.

How to use

The website is generated by mdbook, mdbook serve will start a server at http://localhost:3000 for preview.

Each recipe is accompanied by an illustrative example named after its corresponding sequence number. These examples can be executed using the command zig build run-{chapter-num}-{sequence-num}, or zig build run-all to execute all.

Note

Some recipes may depend on system libraries

  • Use make install-deps to install client libraries, and
  • docker-compose up -d to start required databases.

Contributing

This cookbook is a work in progress, and we welcome contributions from the community. If you have a favorite recipe that you'd like to share, please submit a pull request.

Acknowledgment

When working on zig-cookbook, we benefit a lot from several similar projects, thanks for their awesome work.

Star History

Star History Chart

License

The markdown files are licensed under CC BY-NC-ND 4.0 DEED, and zig files are under MIT.

Last change: 2024-07-07, commit: f0ebde2