Rust template#

A repository template to get started with writing Rust projects.

Features#

• CI/CD support with Tangled
  • Run tests with LLVM code coverage
  • Rustfmt and Clippy for formatting and linting
• Includes MIT & Apache-2.0 licenses for ecosystem compatibility (see Rust API Guidelines book)

Getting started#

Creating a new repository#

1. Clone this repository template
2. In the repository directory, remove .git folder with rm -rf .git
3. In the repository directory, Initialize git repository with git init .

Replace placeholders#

Replace the following placeholders with your editor's find-and-replace:

• _library_ - The name of the library.
• _desc_ - The description of the library.
• _author_ - The author's name of the library. For example, this could be a username, nickname, or real name.
• _email_ - The author's email address. This is optional and can be deleted.
• my_crate - Replace this with the name of your crate.

Configure#

Run scripts locally#