## A Template for Rust Projects

<div align="center">
  <picture>
    <img alt="template-rust-project logo" src="assets/logos/rustacean-flat-happy.svg" height="40%" width="40%">
  </picture>
</div>
<br>

[![Tests](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/tests.yml?label=tests&style=flat&labelColor=282c34&color=4caf50&logo=github)](https://github.com/habedi/template-rust-project/actions/workflows/tests.yml)
[![Lints](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/lints.yml?label=lints&style=flat&labelColor=282c34&color=4caf50&logo=github)](https://github.com/habedi/template-rust-project/actions/workflows/lints.yml)
[![Linux Build](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_linux.yml?label=linux%20build&style=flat&labelColor=282c34&color=4caf50&logo=linux)](https://github.com/habedi/template-rust-project/actions/workflows/build_linux.yml)
[![Windows Build](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_windows.yml?label=windows%20build&style=flat&labelColor=282c34&color=4caf50&logo=github)](https://github.com/habedi/template-rust-project/actions/workflows/build_windows.yml)
[![MacOS Build](https://img.shields.io/github/actions/workflow/status/habedi/template-rust-project/build_macos.yml?label=macos%20build&style=flat&labelColor=282c34&color=4caf50&logo=apple)](https://github.com/habedi/template-rust-project/actions/workflows/build_macos.yml)
<br>
[![Code Coverage](https://img.shields.io/codecov/c/github/habedi/template-rust-project?style=flat&labelColor=282c34&color=ffca28&logo=codecov)](https://codecov.io/gh/habedi/template-rust-project)
[![Code Quality](https://img.shields.io/codefactor/grade/github/habedi/template-rust-project?style=flat&labelColor=282c34&color=4caf50&logo=codefactor)](https://www.codefactor.io/repository/github/habedi/template-rust-project)
[![Crates.io](https://img.shields.io/crates/v/template-rust-project.svg?style=flat&labelColor=282c34&color=f46623&logo=rust)](https://crates.io/crates/template-rust-project)
[![Downloads](https://img.shields.io/crates/d/template-rust-project?style=flat&labelColor=282c34&color=4caf50&logo=rust)](https://crates.io/crates/template-rust-project)
[![Docs.rs](https://img.shields.io/badge/docs.rs-template--rust--project-66c2a5?style=flat&labelColor=282c34&logo=docs.rs)](https://docs.rs/template-rust-project)
<br>
[![Release](https://img.shields.io/github/release/habedi/template-rust-project.svg?style=flat&labelColor=282c34&color=f46623&logo=github)](https://github.com/habedi/template-rust-project/releases/latest)
[![Total Downloads](https://img.shields.io/github/downloads/habedi/template-rust-project/total.svg?style=flat&labelColor=282c34&color=8caf50&logo=github)](https://github.com/habedi/template-rust-project/releases)
[![Docs](https://img.shields.io/badge/docs-latest-007ec6?style=flat&labelColor=282c34&logo=readthedocs)](docs)
[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-007ec6?style=flat&labelColor=282c34&logo=open-source-initiative)](https://github.com/habedi/template-rust-project)
[![Status: Stable](https://img.shields.io/badge/status-stable-green.svg?style=flat&labelColor=282c34)](https://github.com/habedi/template-rust-project)

---

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`
- GitHub badges for tests, builds, code quality and coverage, documentation, etc.

### Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to make a contribution.

### License

This project is licensed under either of these:

* MIT License ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)