a minimal starter template for Zig projects, including build script, source structure, and testing setup.
Requirements
- Zig >= 0.15.0
Quick start
- Clone:
git clone https://github.com/muhammad-fiaz/zig-project-starter.git - Enter:
cd zig-project-starter - Build:
zig build - Run:
zig build run(if a run step is configured) - Test:
zig test
Project layout
build.zig— central build scriptsrc/lib.zig— library codesrc/main.zig— demo executabletests/lib_test.zig— unit testsexamples/— small demos (optional)
Dependencies
- Fetch and save a Zig package:
zig fetch --save https://github.com/owner/zig-package.git - Import a fetched dependency:
@import("zig-cache/deps/github.com-owner-zig-package/src/lib.zig") - Or wire dependencies into
build.zigper your workflow/version of Zig
Notes
- Run
zig fmtto format code. zig-cacheandzig-outare build artifacts and should be ignored by git.
License
- MIT