From 7b8b24292f84c982bd7b67ce2d7980561662fcc0 Mon Sep 17 00:00:00 2001 From: Patryk Niedźwiedziński Date: Sun, 9 Aug 2020 16:14:36 +0200 Subject: Initial commit --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..e719544 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# 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! + * Library functions, modules and overlays go in the respective directories +3. Add your NUR repo name and your cachix repo name (optional) to + [.travis.yml](./.travis.yml) +4. Enable travis for 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 + 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** + +[![Build Status](https://travis-ci.com//nur-packages.svg?branch=master)](https://travis-ci.com//nur-packages) +[![Cachix Cache](https://img.shields.io/badge/cachix--blue.svg)](https://.cachix.org) + + -- cgit 1.4.1