${REPO_NAME_KEBAB}

A Rust library template powered by a reproducible Nix development environment.

Features

• Reproducible Builds: Powered by a devenv Nix environment to ensure everyone uses the exact same tools and dependencies.
• Ready to Use: Just clone and run devenv up.
• Sensible Defaults: Comes with basic example code, tests, and a pre-configured .gitignore.
• Gitea/GitHub Ready: Includes placeholders for repository-specific values.

Requirements

• Nix
• devenv
• direnv (Recommended)

Usage

1. Clone the repository:

   git clone <your-repo-url>
   cd ${REPO_NAME_KEBAB}
   

2. Activate the development environment:

   If you have direnv installed and enabled, the environment will be activated automatically when you enter the directory. Just run:

   direnv allow
   

   Alternatively, you can start the environment manually:

   devenv up
   

   This command will download all dependencies and start any defined services. To just enter a shell with the tools available, run devenv shell.

3. Build and Test: This template uses just as a command runner. The following commands are available:

   • just build: Build the project.
   • just test: Run tests.
   • just lint: Check for formatting and style issues.
   • just deny: Run cargo-deny to check for vulnerabilities.

   You can also use standard Cargo commands directly:

   cargo build
   cargo test
   cargo clippy
   cargo check
   

License

This project is licensed under the GPL-3.0-or-later. See the LICENSE file for details.