324aa50c55
README: change instructions to use templating mechanism instead of forking |
||
---|---|---|
.github | ||
lib | ||
modules | ||
overlays | ||
pkgs/example-package | ||
.gitignore | ||
.travis.yml | ||
LICENSE | ||
README.md | ||
ci.nix | ||
default.nix | ||
overlay.nix |
README.md
nur-packages-template
A template for NUR repositories
Setup
- Click on Use this template to start a repo based on this template. (Do not fork it.)
- Add your packages to the pkgs directory and to
default.nix
- Remember to mark the broken packages as
broken = true;
in themeta
attribute, or travis (and consequently caching) will fail! - Library functions, modules and overlays go in the respective directories
- Remember to mark the broken packages as
- Choose your CI: Depending on your preference you can use github actions (recommended) or Travis ci.
- Github actions: Change your NUR repo name and optionally add a cachix name in .github/workflows/build.yml and change the cron timer to a random value as described in the file
- Travis ci: Change your NUR repo name and optionally your cachix repo name in .travis.yml. Than enable travis in your repo. You can add a cron job in the repository settings on travis to keep your cachix cache fresh
- Change your travis and cachix names on the README template section and delete the rest
- Add yourself to NUR
README template
nur-packages
My personal NUR repository