Required | Recommended | Optional |
---|---|---|
Configure the Cargo.toml file | Change .github/FUNDING.yml file | Change the LICENCE |
Change the README.md file | ||
Change the ci.yml file | ||
Change docs/ (book.toml,installation.md) folder | ||
🎉 Have fun !!! 🎉 | 📚 Learn 📚 | ⭐ Like this template ⭐ |
Directory | Description | Used by ... |
---|---|---|
src/ | The main directory containing the project code | Cargo |
tests/ | The integration test directory | Cargo |
benches/ | The benches directory | Cargo (nightly channel) |
examples/ | The example directory | Cargo |
.github/ | The special github directory | Github |
delete everything before this
This project is awesome writing in rust
- Any system with basic configuration.
- Operating System : Any (Windows / Linux / Mac).
- Cargo/Rust installed (If not download it here).
# https or ssh
git clone https://github.com/ValentinColin/rust-template-project.git
git clone git@github.com:ValentinColin/rust-template-project.git
cargo build --release
cargo test
cargo run --release