{{project-name}}

{{description}}

Getting started

To contribute, install the Rust toolchain, e.g. using rustup:

curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh

You can run the test suite like so:

cargo test --all-targets

{% if false %}

This is a cargo generate template

(This section won't occur when using this template.)

cargo generate is a powerful alternative to the built-in cargo new:

Usage

To install cargo generate, run:

cargo install cargo-generate

Create new template, either from GitHub, or from a local path:

cargo generate --git https://github.com/sshine/workspace-template
cargo generate --path $HOME/Projects/workspace-template

Config

Create a cargo gen shortcut by adding a section to ~/.cargo/config.toml:

[alias]
gen = "generate"

Add your github-username to ~/.cargo/cargo-generate.toml:

[values]
github-username = "sshine"

Learn

Read more about cargo generate here:

• https://github.com/cargo-generate/cargo-generate
• https://cargo-generate.github.io/cargo-generate/index.html

{% endif %}