diff --git a/README.md b/README.md index 077cfbc..fc30b97 100644 --- a/README.md +++ b/README.md @@ -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.) -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) +| General Packages | Note | Version | +| --------------------------- | --------------------------------- | ------- | +| [`gitea-nyx`][gitea-nyx] | Personal Fork | 1.19.3 | +| [`rec-mono-nyx`][recursive] | Personal config of Recursive Mono | 1.0.0 | +| [`libspectre`][spectre] | | 1.0.0 | -## 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 - -![Build and populate cache](https://github.com//nur-packages/workflows/Build%20and%20populate%20cache/badge.svg) +With `overlays`: - -[![Cachix Cache](https://img.shields.io/badge/cachix--blue.svg)](https://.cachix.org) + outputs = { + self, + 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 \ No newline at end of file