Skip to content

ValentinColin/rust-template-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Welcome on a template project

Task to do for configure this template

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 ⭐

Description of directories

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

✨ Project's Title ✨

Issues tag Forks tag Stars Licence

Project Description

This project is awesome writing in rust

Table of Contents

Installation

System requirement

  1. Any system with basic configuration.
  2. Operating System : Any (Windows / Linux / Mac).

Software requirement

  1. Cargo/Rust installed (If not download it here).

Manual installation

# https or ssh
git clone https://github.com/ValentinColin/rust-template-project.git
git clone [email protected]:ValentinColin/rust-template-project.git

cargo build --release

Tests

cargo test

Usage

cargo run --release

Potential Maintainers

📌 Valentin Colin

Credits

contributors