atproto-nix.org / nur
ATproto Nix User Repo
fork atom

updated README.md

atproto-nix.org 19be8fa5 57ea20aa

options
unified split
Changed files
+2 -31
README.md
+2 -31
README.md
··· 1 - # nur-packages-template 2 - 3 - **A template for [NUR](https://github.com/nix-community/NUR) repositories** 4 - 5 - ## Setup 6 - 7 - 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.) 8 - 2. Add your packages to the [pkgs](./pkgs) directory and to 9 - [default.nix](./default.nix) 10 - * Remember to mark the broken packages as `broken = true;` in the `meta` 11 - attribute, or travis (and consequently caching) will fail! 12 - * Library functions, modules and overlays go in the respective directories 13 - 3. Choose your CI: Depending on your preference you can use github actions (recommended) or [Travis ci](https://travis-ci.com). 14 - - 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 15 - to a random value as described in the file 16 - - Travis ci: Change your NUR repo name and optionally your cachix repo name in 17 - [.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 18 - 5. Change your travis and cachix names on the README template section and delete 19 - the rest 20 - 6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository) 21 - 22 - ## README template 23 - 24 1 # ATproto NUR 25 2 26 - **ATproto [NUR](https://github.com/nix-community/NUR) repository** 27 - 28 - <!-- Remove this if you don't use github actions --> 29 - ![Build and populate cache](https://github.com/atproto-nix/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg) 3 + Nix User Repository for ATproto Services and Tools 30 4 31 - <!-- 32 - Uncomment this if you use travis: 5 + Development is primarily done on [Tangled](https://tangled.org) at [@atproto-nix.org/nur](tangled.sh/@atproto-nix.org/nur) with a Github [mirror](https://github.com/atproto-nix/nur). 33 6 34 - [![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages) 35 - --> 36 7 [![Cachix Cache](https://img.shields.io/badge/cachix-atproto-blue.svg)](https://atproto.cachix.org)