2018-07-16 12:14:10 +00:00
|
|
|
# nur-packages-template
|
|
|
|
|
|
|
|
|
|
**A template for [NUR](https://github.com/nix-community/NUR) repositories**
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
|
|
|
|
1. Fork this repo
|
|
|
|
|
2. Add your packages to the [pkgs](./pkgs) directory and to
|
|
|
|
|
[default.nix](./default.nix)
|
|
|
|
|
* Remember to mark the broken packages as `broken = true;` in the `meta`
|
|
|
|
|
attribute, or travis (and consequently caching) will fail!
|
2018-07-21 13:55:00 +00:00
|
|
|
* Library functions, modules and overlays go in the respective directories
|
2018-07-16 12:14:10 +00:00
|
|
|
3. Add your NUR repo name and your cachix repo name (optional) to
|
|
|
|
|
[.travis.yml](./.travis.yml)
|
2018-07-16 12:27:12 +00:00
|
|
|
* If you use cachix you should also add your cache's private key to travis'
|
|
|
|
|
protected env variables
|
2018-07-16 12:14:10 +00:00
|
|
|
4. Enable travis for your repo
|
2018-07-16 18:50:52 +00:00
|
|
|
* You can add a cron job in the repository settings on travis to keep your
|
|
|
|
|
cachix cache fresh
|
2018-07-16 12:14:10 +00:00
|
|
|
5. Change your travis and cachix names on the README template section and delete
|
|
|
|
|
the rest
|
|
|
|
|
6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository)
|
|
|
|
|
|
|
|
|
|
## README template
|
|
|
|
|
|
|
|
|
|
# nur-packages
|
|
|
|
|
|
|
|
|
|
**My personal [NUR](https://github.com/nix-community/NUR) repository**
|
|
|
|
|
|
|
|
|
|
[](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages)
|
2018-07-16 12:43:50 +00:00
|
|
|
[](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)
|
2018-07-16 12:14:10 +00:00
|
|
|
|
|
|
|
|
|
