Skip to content

About

An opinionated Copier template for Rust projects

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

121 Commits

Folders and files

Repository files navigation

Rust project template

An opinionated Copier template for Rust projects.

Features

Quickstart

First, install Copier.

Then, to create a new project based on this template, run the following command and fill in the form:

copier copy 'https://github.com/vivienm/copier-rust' path/to/your/project

Go to the project directory and initialize a Git repository:

cd path/to/your/project
git init

If you enabled nix_flake, use Nix with flakes enabled. Track the generated files and enter the development shell, which provides Rust and all required development tools:

git add .
nix develop

Otherwise, install Rust using rustup, then install the required components and development tools (cargo-edit provides cargo upgrade):

rustup component add rustfmt clippy
cargo install --locked cargo-edit just cargo-audit typos-cli

Update the dependencies and format the code:

cargo upgrade --incompatible
cargo update
cargo fmt

Run the tests:

just ci

If you enabled github_pages, configure your GitHub repository before the first push to its default branch: in Settings → Pages → Build and deployment, set Source to GitHub Actions. The generated workflow will then publish the library documentation.

You are now ready to start coding!

Later, to update your project as this template evolves, run:

copier update --skip-answered

About

An opinionated Copier template for Rust projects

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages