template-rust-project 0.1.0

A template for Rust projects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# 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 src="https://github.com/habedi/template-rust-project/actions/workflows/tests.yml/badge.svg" alt="Tests">
  </a>
  <a href="https://github.com/habedi/template-rust-project/actions/workflows/build_linux.yml">
    <img src="https://github.com/habedi/template-rust-project/actions/workflows/build_linux.yml/badge.svg" alt="Linux Build">
  </a>
  <a href="https://github.com/habedi/template-rust-project/actions/workflows/build_windows.yml">
    <img src="https://github.com/habedi/template-rust-project/actions/workflows/build_windows.yml/badge.svg" alt="Windows Build">
  </a>
  <a href="https://github.com/habedi/template-rust-project/actions/workflows/build_macos.yml">
    <img src="https://github.com/habedi/template-rust-project/actions/workflows/build_macos.yml/badge.svg" alt="MacOS Build">
  </a>
  <br>
    <a href="https://crates.io/crates/template-rust-project">
    <img src="https://img.shields.io/crates/v/template-rust-project" alt="Crates.io">
    </a>
    <a href="docs">
    <img src="https://img.shields.io/badge/docs-latest-blue" alt="Docs">
    </a>
  <a href="https://codecov.io/gh/habedi/template-rust-project">
    <img src="https://codecov.io/gh/habedi/template-rust-project/graph/badge.svg?token=1RUL13T0VE" alt="Code Coverage">
  </a>
  <a href="https://www.codefactor.io/repository/github/habedi/template-rust-project">
    <img src="https://www.codefactor.io/repository/github/habedi/template-rust-project/badge" alt="CodeFactor">
  </a>
  <a href="https://github.com/habedi/template-rust-project/releases/latest">
    <img src="https://img.shields.io/github/release/habedi/template-rust-project.svg?style=flat-square" alt="Release">
  </a>
  <a href="https://github.com/habedi/template-rust-project/releases">
  <img src="https://img.shields.io/github/downloads/habedi/template-rust-project/total.svg" alt="Total Downloads">
  </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 testing and building
- Makefile for managing different tasks such as formatting, testing, and linting
- Example configuration files

## Contributing

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

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.