https://github.com/fast/template
Fast template for developing a new Rust project
https://github.com/fast/template
Last synced: 4 months ago
JSON representation
Fast template for developing a new Rust project
- Host: GitHub
- URL: https://github.com/fast/template
- Owner: fast
- License: apache-2.0
- Created: 2024-11-12T14:09:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T12:18:12.000Z (over 1 year ago)
- Last Synced: 2025-05-11T12:37:42.442Z (about 1 year ago)
- Language: Rust
- Homepage:
- Size: 16.6 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fast template for developing a new Rust project
[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]
[![MSRV 1.85][msrv-badge]](https://www.whatrustisit.com)
[![Apache 2.0 licensed][license-badge]][license-url]
[![Build Status][actions-badge]][actions-url]
[crates-badge]: https://img.shields.io/crates/v/${projectName}.svg
[crates-url]: https://crates.io/crates/${projectName}
[docs-badge]: https://img.shields.io/docsrs/${projectName}
[docs-url]: https://docs.rs/${projectName}
[msrv-badge]: https://img.shields.io/badge/MSRV-1.85-green?logo=rust
[license-badge]: https://img.shields.io/crates/l/${projectName}
[license-url]: LICENSE
[actions-badge]: https://github.com/fast/template/workflows/CI/badge.svg
[actions-url]: https://github.com/fast/template/actions?query=workflow%3ACI
Use this repository as a GitHub template to quickly start a new Rust project.
## Getting Started
1. Create a new repository using this template;
2. Clone your repository and run the bootstrap script: `cargo x bootstrap`;
3. Cleanup the bootstrap scaffolding: `cargo x bootstrap --cleanup`;
4. Start building your project!
## Minimum Rust version policy
This crate's minimum supported `rustc` version is `1.85.0`.
The current policy is that the minimum Rust version required to use this crate can be increased in minor version updates. For example, if `crate 1.0` requires Rust 1.85.0, then `crate 1.0.z` for all values of `z` will also require Rust 1.85.0 or newer. However, `crate 1.y` for `y > 0` may require a newer minimum version of Rust.
## License
This project is licensed under [Apache License, Version 2.0](LICENSE).