rust-template-example

An example showcasing the usage of https://github.com/PRO-2684/rust-template.

⚙️ Automatic Releases Setup

1. Create a new GitHub repository with the name rust-template-example and push this generated project to it.

2. Enable Actions for the repository, and grant "Read and write permissions" to the workflow here.

3. Generate an API token on crates.io, with the following setup:

   • Name: rust-template-example
   • Expiration: No expiration
   • Scopes: publish-new, publish-update
   • Crates: rust-template-example

4. Add a repository secret named CARGO_TOKEN with the generated token as its value.

5. Consider removing this section and updating this README with your own project information.

Trusted Publishing is a recent feature added to crates.io. To utilize it, first make sure you've already successfully published the crate to crates.io. Then, follow these steps:

1. Add a new trusted publisher to your crate.
   • Set "Workflow filename" to release.yml.
   • Keep other fields intact.
   • Click "Add".
2. Modify release.yml.
   1. Comment out or remove the publish-release job.
   2. Un-comment the trusted-publishing job.
3. Remove the CARGO_TOKEN repository secret.

📥 Installation

Using binstall

cargo binstall rust-template-example

Downloading from Releases

Navigate to the Releases page and download respective binary for your platform. Make sure to give it execute permissions.

Compiling from Source

cargo install rust-template-example

💡 Examples

TODO

📖 Usage

TODO

🎉 Credits

TODO