51 lines
4.2 KiB
Markdown
51 lines
4.2 KiB
Markdown
## 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>
|
|
|
|
[](https://github.com/habedi/template-rust-project/actions/workflows/tests.yml)
|
|
[](https://github.com/habedi/template-rust-project/actions/workflows/lints.yml)
|
|
[](https://github.com/habedi/template-rust-project/actions/workflows/build_linux.yml)
|
|
[](https://github.com/habedi/template-rust-project/actions/workflows/build_windows.yml)
|
|
[](https://github.com/habedi/template-rust-project/actions/workflows/build_macos.yml)
|
|
<br>
|
|
[](https://codecov.io/gh/habedi/template-rust-project)
|
|
[](https://www.codefactor.io/repository/github/habedi/template-rust-project)
|
|
[](https://crates.io/crates/template-rust-project)
|
|
[](https://crates.io/crates/template-rust-project)
|
|
[](https://docs.rs/template-rust-project)
|
|
<br>
|
|
[](https://github.com/habedi/template-rust-project/releases/latest)
|
|
[](https://github.com/habedi/template-rust-project/releases)
|
|
[](docs)
|
|
[](https://github.com/habedi/template-rust-project)
|
|
[](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)
|