Robinson Group Rust Template

This repo serves as a template for rust projects in the Robinson Group of the BIH.

How to use this template

To the top right-hand side of this repository, you will find a button labeled $${\color{green}Use \space this \space Template}$$. Press it and then click on Create a new repository. This will copy the contents of the repository to your account.

CI

The CI uses nexttest, rustfmt and clippy to test, format and lint your code.

Releases to Crates IO

The Template features a Github Action to publish to crates.io. To use this

1. Create a Github token at https://github.com/settings/tokens
2. Then store the token as PERSONLA_TOKEN in your repository secrets.
3. Go to crates.io, create an account, if you haven't already, and create a API Token.
4. Add that token also to your repository secrets as CARGO_REGISTRY_TOKEN

You can run the release pipeline manually in the actions tab:

The action will publish to crates.io, create a github release and open a PR to bump to your new version.

Educational Material

• The Rust Book and The Cargo Book.
• Rustlings

License

This project is licensed under MIT.