From f9374247b167c14eb7ade521245491377a27d508 Mon Sep 17 00:00:00 2001 From: Tim Van Baak Date: Sun, 28 Jul 2024 20:51:48 -0700 Subject: [PATCH] README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6c3038 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# maintainers + +This flake provides two bundlers that compile information about the maintainership of packages. + +## #unmaintained (#default) + +This bundler accepts a derivation or a NixOS configuration and returns a report containing a list of derivations in the closure of the input that have no maintainer in nixpkgs. Each package is accompanied by a link to the package source in nixpkgs. If you see a package in your report that you care about, sign up as a maintainer! + +Note that many derivations have no `.meta.maintainers`, e.g. `fetchTarball`. This list specificaly includes packages that _have_ a `.meta.maintainers` that is empty. + +## #all + +This bundler accepts a derivation or a NixOS configuration and returns a report containing a list of every derivation in the closure of the input and the GitHub usernames of the maintainers. You can use this to see if there are packages you depend on that could use some additional maintainership, e.g. yours!