sanctureplicum
/
nur
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

main
Carsten Kragelund 2023-05-10 06:02:56 +02:00
parent dc3524b2fa
commit d123b44ed6
Signed by: nyx
GPG Key ID: CADDADEEC9F753C0
1 changed files with 61 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
README.md
Unescape Escape View File

@ -1,37 +1,71 @@
# nur-packages-template # sanctureplicum/nur
**A template for [NUR](https://github.com/nix-community/NUR) repositories** [![Cachix Cache](https://img.shields.io/badge/cachix-sanctureplicum-blue.svg)](https://sanctureplicum.cachix.org)
## Setup ## What's available
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.) | General Packages | Note | Version |
2. Add your packages to the [pkgs](./pkgs) directory and to | --------------------------- | --------------------------------- | ------- |
[default.nix](./default.nix) | [`gitea-nyx`][gitea-nyx] | Personal Fork | 1.19.3 |
* Remember to mark the broken packages as `broken = true;` in the `meta` | [`rec-mono-nyx`][recursive] | Personal config of Recursive Mono | 1.0.0 |
attribute, or travis (and consequently caching) will fail! | [`libspectre`][spectre] | | 1.0.0 |
* 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 | Firefox Addons | Note | Version |
| ------------------------------------------ | -------------------------------- | ------- |
| [`duplicate-tab-shortcut`][duplicate-tab] | | 1.5.3 |
| [`istilldontcareaboutcookies`][isdcac] | | 1.1.1 |
| [`masterpassword-firefox`][masterpassword] | Spectre, formerly MasterPassword | 2.9.5 |
# nur-packages | Emacs Packages | Note | Version |
| ----------------------------- | ----- | ------- |
| [`spectre-el`][spectre-emacs] | | 0.3.0 |
**My personal [NUR](https://github.com/nix-community/NUR) repository** ## Usage
<!-- Remove this if you don't use github actions --> With `overlays`:
![Build and populate cache](https://github.com/<YOUR-GITHUB-USER>/nur-packages/workflows/Build%20and%20populate%20cache/badge.svg)
<!-- ```nix
Uncomment this if you use travis: {
inputs = {
nur.url = "github:nix-community/NUR";
sanctureplicum-nur.url = "git+https://gitea.pid1.sh/sanctureplicum/nur.git";
};
[![Build Status](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages.svg?branch=master)](https://travis-ci.com/<YOUR_TRAVIS_USERNAME>/nur-packages) outputs = {
--> self,
[![Cachix Cache](https://img.shields.io/badge/cachix-<YOUR_CACHIX_CACHE_NAME>-blue.svg)](https://<YOUR_CACHIX_CACHE_NAME>.cachix.org) nixpkgs,
nur,
sanctureplicum-nur,
...
}: let
overlays = final: prev: {
nur = import nur {
nurpkgs = prev;
pkgs = prev;
repoOverrides = { sanctureplicum = import sanctureplicum-nur { pkgs = prev; }; };
};
# ... your other overlays
};
in {
system = "x86_64-linux";
modules = [
({ config, ... }: {
config = {
nixpkgs.overlays = [
overlays
];
};
})
];
};
}
```
[gitea-nyx]: https://gitea.pid1.sh/sanctureplicum/gitea
[recursive]: https://recursive.design
[spectre]: https://spectre.app
[duplicate-tab]: https://github.com/stefansundin/duplicate-tab
[isdcac]: https://github.com/OhMyGuus/I-Dont-Care-About-Cookies
[masterpassword]: https://github.com/ttyridal/masterpassword-firefox/wiki
[spectre-emacs]: https://github.com/nyxkrage/spectre-emacs