From 84af58b0c692e7f6c8bd62bd68c36bcedd8e721f Mon Sep 17 00:00:00 2001 From: Carlos Alexandro Becker Date: Thu, 29 Jun 2023 16:46:22 +0000 Subject: [PATCH] fix: template Signed-off-by: Carlos Alexandro Becker --- README.md | 38 +++----------------------------- pkgs/example-package/default.nix | 9 -------- 2 files changed, 3 insertions(+), 44 deletions(-) delete mode 100644 pkgs/example-package/default.nix diff --git a/README.md b/README.md index 077cfbc..6a5f603 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,5 @@ -# nur-packages-template +# nur -**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** - - -![Build and populate cache](https://github.com//nur-packages/workflows/Build%20and%20populate%20cache/badge.svg) - - -[![Cachix Cache](https://img.shields.io/badge/cachix--blue.svg)](https://.cachix.org) +**Charm's [NUR](https://github.com/nix-community/NUR) repository** +![Build and populate cache](https://github.com/charmbracelet/nur/workflows/Build%20and%20populate%20cache/badge.svg) diff --git a/pkgs/example-package/default.nix b/pkgs/example-package/default.nix deleted file mode 100644 index 41e22df..0000000 --- a/pkgs/example-package/default.nix +++ /dev/null @@ -1,9 +0,0 @@ -{ stdenv }: - -stdenv.mkDerivation rec { - name = "example-package-${version}"; - version = "1.0"; - src = ./.; - buildPhase = "echo echo Hello World > example"; - installPhase = "install -Dm755 example $out"; -}