Skip to content

Commit 90ffc8c

Browse files
committed
update README
1 parent f40d7e6 commit 90ffc8c

File tree

1 file changed

+2
-26
lines changed

1 file changed

+2
-26
lines changed

README.md

+2-26
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,13 @@
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-
241
# nur-packages
252

263
**My personal [NUR](https://github.com/nix-community/NUR) repository**
274

285
<!-- Remove this if you don't use github actions -->
29-
![Build and populate cache](https://github.com/<YOUR-GITHUB-USER>/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
6+
![Build and populate cache](https://github.com/foolnotion/nur-pkg/workflows/Build%20and%20populate%20cache/badge.svg)
307

318
<!--
329
Uncomment this if you use travis:
3310
3411
[![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages)
35-
-->
3612
[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org)
37-
13+
-->

0 commit comments

Comments
 (0)