|
1 | | -# nur-packages-template |
| 1 | +# Nixathena |
2 | 2 |
|
3 | | -**A template for [NUR](https://github.com/nix-community/NUR) repositories** |
| 3 | +This is Nixathena, a vague start at a package repo for using MIT Athena on [NixOS](https://nixos.org/), inspired by [Debathena](https://debathena.mit.edu/). |
4 | 4 |
|
5 | | -## Setup |
| 5 | +Eventually I may [add it](https://github.com/nix-community/NUR#how-to-add-your-own-repository) as a [Nix User Repository](https://github.com/nix-community/NUR) (and have used that template), but I don't think it's stable enough for that yet. |
6 | 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 | | -# nur-packages |
25 | | - |
26 | | -**My personal [NUR](https://github.com/nix-community/NUR) repository** |
| 7 | +## CI status |
27 | 8 |
|
28 | 9 | <!-- Remove this if you don't use github actions --> |
29 | | - |
| 10 | + |
30 | 11 |
|
31 | 12 | <!-- |
32 | 13 | Uncomment this if you use travis: |
33 | 14 |
|
34 | 15 | [](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages) |
35 | 16 | --> |
36 | | -[](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org) |
37 | | - |
| 17 | +[](https://nixathena.cachix.org) |
0 commit comments