Skip to content

habedi/template-zig-project

Zig Project Template

Zig Logo

Tests Lints Code Coverage CodeFactor Docs License Release

This is a project template for Zig projects. It provides a minimalistic project structure with pre-configured GitHub Actions, Makefile, and a few useful configuration files. I share it here in case it might be useful to others.

Features

  • Minimalistic project structure
  • Pre-configured GitHub Actions for linting and testing
  • Makefile for managing the development workflow and tasks like code formatting, testing, linting, etc.
  • GitHub badges for tests, code quality and coverage, documentation, etc.
  • Code of Conduct and Contributing Guidelines

Getting Started

Check out the Makefile for available commands to manage the development workflow of the project.

# Install system and development dependencies (for Debian-based systems)
sudo apt-get install make
make install-deps
# See all available commands and their descriptions
make help

Contributing

See CONTRIBUTING.md for details on how to make a contribution.

License

This project is licensed under the MIT License (LICENSE or https://opensource.org/licenses/MIT)

About

A template for Zig projects 🦎

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks