aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authornsfisis <nsfisis@gmail.com>2025-05-10 00:42:32 +0900
committernsfisis <nsfisis@gmail.com>2025-05-10 00:42:32 +0900
commit2fb8b9e6a0d06a75f9aa9406d999f924daf03856 (patch)
tree5f9a41a69ea3e7c5a904969b3011e34d3f1b9403 /README.md
parent20b7f6efbf44ed10a76adfcf07ae858f3512399a (diff)
downloadnur-packages-2fb8b9e6a0d06a75f9aa9406d999f924daf03856.tar.gz
nur-packages-2fb8b9e6a0d06a75f9aa9406d999f924daf03856.tar.zst
nur-packages-2fb8b9e6a0d06a75f9aa9406d999f924daf03856.zip
chore(meta): update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 1 insertions, 33 deletions
diff --git a/README.md b/README.md
index 077cfbc..4182a7f 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,5 @@
-# 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
- [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. 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)
-
-## README template
-
# nur-packages
**My personal [NUR](https://github.com/nix-community/NUR) repository**
-<!-- Remove this if you don't use github actions -->
-![Build and populate cache](https://github.com/<YOUR-GITHUB-USER>/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
-
-<!--
-Uncomment this if you use travis:
-
-[![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages)
--->
-[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)
-
+![Build and populate cache](https://github.com/nsfisis/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)