diff --git a/README.md b/README.md index 35fe3749ecb2180e4098cc654eae38aa0aafe845..077cfbc6b0bfd79af676aeb41319d260ef01bc71 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,40 @@ +# nur-packages-template + +**A template for [NUR](https://github.com/nix-community/NUR) repositories** + +## Setup + +1. Click on [Use this template](https://github.com/nix-community/nur-packages-template/generate) to start a repo based on this template. (Do _not_ fork it.) +2. Add your packages to the [pkgs](./pkgs) directory and to # jolheiser NUR + * Remember to mark the broken packages as `broken = true;` in the `meta` +# jolheiser NUR +# jolheiser NUR ## Packages +3. Choose your CI: Depending on your preference you can use github actions (recommended) or [Travis ci](https://travis-ci.com). + - Github actions: Change your NUR repo name and optionally add a cachix name in [.github/workflows/build.yml](./.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](./.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 +5. Change your travis and cachix names on the README template section and delete +6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository) + +## README template + +# nur-packages + + - [tmpl](https://git.jojodev.com/jolheiser/tmpl) \ No newline at end of file + + +![Build and populate cache](https://github.com//nur-packages/workflows/Build%20and%20populate%20cache/badge.svg) + + +[![Cachix Cache](https://img.shields.io/badge/cachix--blue.svg)](https://.cachix.org) +