Repository files navigation

• workspace support
• build withcrane
• most recent and/or custom rust toolchain withfenix
• cargo clippy, fmt, test, doc and audit as flake checks
• complete Github CI with automatic lockfile updates, flake checks, build
• automatic bundling of releases (deb, rpm, pacman, AppImage, Docker) for aarch64-linux and x86_64-linux

• Nix has to be installed andflakes and the experimental nix command have to be enabled
• (optional) install and setupdirenv to automatically enter the dev shell in this directory
• (optional) obtain apersonal GitHub access tokenwith read and write access on this repository for automatic flake updates. Automatic flake updates also work withouta personal access token, but pipelines won't trigger for the update pull requests if you use the standard GitHub Bot user

• click "use this template" to create your repository
• rename or remove the existing crates
  • rename or recreate all crates undercrates/ with names of your choosing
  • inCargo.toml change the paths in the[members] field to the crates you just created/renamed
  • in.github/workflows/ci.yml replace/delete "client" and "server" in the job matrix for "bundle" amd "build"
  • inflake.nix
    • replace/delete "client-package" and "server-package" with "$name-package"
    • replace/deletepackages.client andpackages.server topackages.$name
    • replace/delete theinherit client-package server-package in the devShell section with the new names andadd/remove any crates you added/removed
• create the repository secretGH_TOKEN_FOR_UPDATES with your personal GitHub access token or replace${{ secrets.GH_TOKEN_FOR_UPDATES }} with${{ secrets.GITHUB_TOKEN }} in.github/workflows/update.yml
• (optional) enable theRenovate bot for automatic rust and actions dependency updatesor deleterenovate.json
• (optional) allow direnv to run:direnv allow

• nix build to build
• nix flake check to run tests
• nix develop to enter the dev shell (happens automatically when using direnv)

• darwin support
• cross compilation for windows
• code coverage checks
• actions/scripts to automate most of [Getting Started]