rust_template

A rust template
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is a Rust template designed to help you quickly set up a new Rust project with a predefined structure and commonly used configurations.

(back to top)

Built With

• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

First of all, you need to make sure that rustc and cargo are installed. If not, you should go to the official Rust installation guide.

Setting

1. Clone the repo

   git clone https://github.com/King-sj/rust_template.git

2. Delete README.md and replace it with Blank-Readme.md.
3. (Not required) Move config.toml to a global location (More Details) if you want to use this template more quickly in another project in the future.

   cargo install cargo-generate
   # Create a new Rust project using this template
   cargo g
   # The following are equivalent:
   # cargo gen
   # cargo generate
   # git clone https://github.com/King-sj/rust_template.git

(back to top)

Usage

main.rs should not contain too much content, only serving as the entry point of the program. lib.rs should only expose module interfaces, with actual functionality implemented in each module.

Remember to replace README.md with BLANK_README.md. For more information, please refer to the Documentation

(back to top)

Roadmap

Not more

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MPL-2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

SongJian - [email protected]

Project Link: https://github.com/King-sj/rust_template

(back to top)

Acknowledgments

• Rust Programming Language
• Cargo
• Rust Book

(back to top)