From 391dd61e7ca3f020326594fb824d44fcf0979176 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Thalheim?= Date: Thu, 13 Aug 2020 08:48:38 +0100 Subject: [PATCH] README: add github actions documentation --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e719544..4416b96 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ * 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 +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 the rest 6. [Add yourself to NUR](https://github.com/nix-community/NUR#how-to-add-your-own-repository) @@ -25,7 +25,14 @@ **My personal [NUR](https://github.com/nix-community/NUR) repository** + +![Build and populate cache](https://github.com/nix-community//workflows/Build%20and%20populate%20cache/badge.svg) + + [![Cachix Cache](https://img.shields.io/badge/cachix--blue.svg)](https://.cachix.org)