# A Template for Rust Projects
<div align="center">
<picture>
<source media="(prefers-color-scheme: light)" srcset="assets/logos/rustacean-flat-happy.svg">
<source media="(prefers-color-scheme: dark)" srcset="assets/logos/rustacean-flat-happy.svg">
<img alt="template-rust-project logo" src="assets/logos/rustacean-flat-happy.svg" height="40%" width="40%">
</picture>
</div>
<br>
<p align="center">
<a href="https://github.com/habedi/template-rust-project/actions/workflows/tests.yml">
<img alt="Tests" src="https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/tests.yml?label=Tests&style=flat&labelColor=555555&logo=github">
</a>
<a href="https://github.com/habedi/template-rust-project/actions/workflows/build_linux.yml">
<img alt="Linux Build" src="https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_linux.yml?label=Linux%20Build&style=flat&labelColor=555555&logo=linux">
</a>
<a href="https://github.com/habedi/template-rust-project/actions/workflows/build_windows.yml">
<img alt="Windows Build" src="https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_windows.yml?label=Windows%20Build&style=flat&labelColor=555555&logo=github">
</a>
<a href="https://github.com/habedi/template-rust-project/actions/workflows/build_macos.yml">
<img alt="MacOS Build" src="https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_macos.yml?label=MacOS%20Build&style=flat&labelColor=555555&logo=apple">
</a>
<br>
<a href="docs">
<img alt="Docs" src="https://img.shields.io/badge/docs-latest-3776ab?style=flat&labelColor=555555&logo=readthedocs">
</a>
<a href="https://github.com/habedi/template-rust-project">
<img alt="License" src="https://img.shields.io/badge/license-MIT%2FApache--2.0-007ec6?style=flat&labelColor=555555&logo=open-source-initiative">
</a>
<a href="https://codecov.io/gh/habedi/template-rust-project">
<img alt="Code Coverage" src="https://img.shields.io/codecov/c/github/habedi/template-rust-project?style=flat&labelColor=555555&logo=codecov">
</a>
<a href="https://www.codefactor.io/repository/github/habedi/template-rust-project">
<img alt="CodeFactor" src="https://img.shields.io/codefactor/grade/github/habedi/template-rust-project?style=flat&labelColor=555555&logo=codefactor">
</a>
<br>
<a href="https://crates.io/crates/template-rust-project">
<img alt="Crates.io" src="https://img.shields.io/crates/v/template-rust-project.svg?style=flat&color=fc8d62&logo=rust">
</a>
<a href="https://docs.rs/template-rust-project">
<img alt="Docs.rs" src="https://img.shields.io/badge/docs.rs-template--rust--project-66c2a5?style=flat&labelColor=555555&logo=docs.rs">
</a>
<a href="https://crates.io/crates/template-rust-project">
<img alt="Downloads" src="https://img.shields.io/crates/d/template-rust-project?style=flat&labelColor=555555&logo=rust">
</a>
<a href="https://github.com/habedi/template-rust-project/releases/latest">
<img alt="Release" src="https://img.shields.io/github/release/habedi/template-rust-project.svg?style=flat&labelColor=555555&logo=github">
</a>
<a href="https://github.com/habedi/template-rust-project/releases">
<img alt="Total Downloads" src="https://img.shields.io/github/downloads/habedi/template-rust-project/total.svg?style=flat&labelColor=555555&logo=github">
</a>
</p>
This is a template repository with a minimalistic structure to make it easier to start a new Rust project.
I share it here in case it might be useful to others.
## Features
- Minimalistic project structure
- Pre-configured GitHub Actions for running tests and making releases for different platforms
- Makefile for managing common tasks such as formatting, testing, linting, and building
- Example configuration files for common tools like `rustfmt`, `clippy`, and `editorconfig`
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution.
## License
This project is licensed either under the [MIT License](LICENSE-MIT) or the [Apache License 2.0](LICENSE-APACHE), at
your option.