docs: add generated packages readme

apps/gen-docs/script.sh

@@ -20,5 +20,7 @@ substitute() {
     ) -t markdown --template "$2" -o "$3"
 }
 
-substitute "devShells" "$FLAKE/apps/gen-docs/templates/devShells.md" "$FLAKE/devShells/README.md"
+# TODO: add configurations, homeManagerModules, lib, modules, nixFastChecks, overlays, packages, scopedPackages
 substitute "appsPackages" "$FLAKE/apps/gen-docs/templates/apps.md" "$FLAKE/apps/README.md"
+substitute "devShells" "$FLAKE/apps/gen-docs/templates/devShells.md" "$FLAKE/devShells/README.md"
+substitute "packages" "$FLAKE/apps/gen-docs/templates/packages.md" "$FLAKE/packages/README.md"

apps/gen-docs/templates/packages.md

@@ -0,0 +1,11 @@
+# Packages
+
+This directory contains every derivations for packages exposed by this flake.
+
+## List of my packages found in `self.packages`
+
+| Name | Description |
+| ---- | ----------- |
+$for(attrs/pairs)$
+| `$it.key$` | $it.value.desc/nowrap$ | $it.value.homepage/nowrap$ |
+$endfor$

packages/README.md

@@ -4,12 +4,19 @@ This directory contains every derivations for packages exposed by this flake.
 
 ## List of my packages found in `self.packages`
 
-| Name                           | Source / Description |
-| ------------------------------ | -------------------- |
-| `gpu-screen-recorder`          | [Git](https://git.dec05eba.com/gpu-screen-recorder/about) |
-| `pam-fprint-grosshack`         | [GitLab](https://gitlab.com/mishakmak/pam-fprint-grosshack) |
-| `pokemon-colorscripts`         | [GitLab](https://gitlab.com/phoneybadger/pokemon-colorscripts) |
-| `proton-ge-latest`             | [Github](https://github.com/GloriousEggroll/proton-ge-custom) patched with persistent name in Steam |
-| `protonhax`                    | [Github](https://github.com/jcnils/protonhax) |
-| `repl`                         | nix repl forked from [here](https://github.com/fufexan/dotfiles/blob/main/pkgs/repl/default.nix) |
-| `trash-d`                      | [Github](https://github.com/rushsteve1/trash-d) |
+| Name | Description | Homepage |
+| ---- | ----------- | -------- |
+| `gpu-screen-recorder` | Screen recorder that has minimal impact on system performance by recording a window using the GPU only | https://git.dec05eba.com/gpu-screen-recorder/about/ |
+| `gsr-kms-server` | Screen recorder that has minimal impact on system performance by recording a window using the GPU only | https://git.dec05eba.com/gpu-screen-recorder/about/ |
+| `homepage` | Highly customisable dashboard with Docker and service API integrations | https://gethomepage.dev |
+| `libratbag` | Configuration library for gaming mice | https://github.com/libratbag/libratbag |
+| `librespot-auth` | A simple program for populating a credentials.json via Spotify's zeroconf authentication. | https://github.com/dspearson/librespot-auth |
+| `pam-fprint-grosshack` | This is a fork of the pam module which implements the simultaneous password and fingerprint behaviour present in pam_thinkfinger. | https://gitlab.com/mishakmak/pam-fprint-grosshack |
+| `piper` | GTK frontend for ratbagd mouse config daemon | https://github.com/libratbag/piper |
+| `pokemon-colorscripts` | A script to print out images of pokemon to the terminal. | https://gitlab.com/phoneybadger/pokemon-colorscripts |
+| `proton-ge-latest` | Compatibility tool for Steam Play based on Wine and additional components. (This is intended for use in the `programs.steam.extraCompatPackages` option only.) | https://github.com/GloriousEggroll/proton-ge-custom |
+| `protonhax` | Tool to help running other programs (i.e. Cheat Engine) inside Steam's proton. | https://github.com/jcnils/protonhax |
+| `repl` | A simple program for populating a credentials.json via Spotify's zeroconf authentication. | fork of https://github.com/fufexan/dotfiles/blob/main/pkgs/repl/default.nix |
+| `some-sass-language-server` | Some Sass is a language server extension for Visual Studio Code and other editors with a language server protocol (LSP) client. It brings improved code suggestions, documentation and code navigation for both SCSS and indented syntaxes. | https://github.com/wkillerud/some-sass |
+| `trash-d` | A near drop-in replacement for `rm` that uses the [FreeDesktop trash bin](https://specifications.freedesktop.org/trash-spec/trashspec-latest.html). | https://github.com/rushsteve1/trash-d |
+| `urllib3` | Powerful, sanity-friendly HTTP client for Python | https://github.com/shazow/urllib3 |

packages/librespot-auth/default.nix

@@ -35,10 +35,10 @@ rustPlatform.buildRustPackage rec {
     openssl
   ];
 
-  meta = with lib; {
+  meta = {
     description = "A simple program for populating a credentials.json via Spotify's zeroconf authentication.";
     mainProgram = pname;
     homepage = "https://github.com/dspearson/librespot-auth";
-    license = with licenses; [isc];
+    license = with lib.licenses; [isc];
   };
 }

packages/pam-fprint-grosshack/default.nix

@@ -1,4 +1,5 @@
 {
+  lib,
   pam-fprint-grosshack-src,
   dbus,
   glib,
@@ -41,4 +42,11 @@ in
       "-Ddbus_service_dir=${placeholder "out"}/share/dbus-1/system-services"
       "-Dsystemd_system_unit_dir=${placeholder "out"}/lib/systemd/system"
     ];
+
+    meta = {
+      description = "This is a fork of the pam module which implements the simultaneous
+password and fingerprint behaviour present in pam_thinkfinger.";
+      homepage = "https://gitlab.com/mishakmak/pam-fprint-grosshack";
+      license = with lib.licenses; [gpl2Plus];
+    };
   }

packages/pokemon-colorscripts/default.nix

@@ -25,4 +25,9 @@ stdenv.mkDerivation {
 
     ln -s $out/pokemon-colorscripts/pokemon-colorscripts.py $out/bin/pokemon-colorscripts
   '';
+
+  meta = {
+    description = "A script to print out images of pokemon to the terminal.";
+    homepage = "https://gitlab.com/phoneybadger/pokemon-colorscripts";
+  };
 }

packages/protonhax/default.nix

@@ -1,4 +1,5 @@
 {
+  lib,
   mkVersion,
   protonhax-src,
   stdenv,
@@ -13,4 +14,10 @@ stdenv.mkDerivation {
   installPhase = ''
     install -Dt $out/bin -m755 protonhax
   '';
+
+  meta = {
+    description = "Tool to help running other programs (i.e. Cheat Engine) inside Steam's proton.";
+    homepage = "https://github.com/jcnils/protonhax";
+    license = with lib.licenses; [bsd3];
+  };
 }

packages/repl/default.nix

@@ -38,4 +38,9 @@ in
           ;;
       esac
     '';
+
+    meta = {
+      description = "A simple program for populating a credentials.json via Spotify's zeroconf authentication.";
+      homepage = "fork of https://github.com/fufexan/dotfiles/blob/main/pkgs/repl/default.nix";
+    };
   }

packages/some-sass-language-server/default.nix

@@ -1,4 +1,5 @@
 {
+  lib,
   writeShellApplication,
   nodejs_latest,
   prefetch-npm-deps,
@@ -8,9 +9,10 @@
   ...
 }: let
   package = builtins.fromJSON (builtins.readFile ./package.json);
+  pname = "some-sass-language-server";
 in
   buildNpmPackage {
-    pname = "some-sass-language-server";
+    inherit pname;
     version = package.dependencies.some-sass-language-server;
 
     src = ./.;
@@ -35,4 +37,11 @@ in
       ];
       text = import ./update.nix;
     };
+
+    meta = {
+      description = "Some Sass is a language server extension for Visual Studio Code and other editors with a language server protocol (LSP) client. It brings improved code suggestions, documentation and code navigation for both SCSS and indented syntaxes.";
+      mainProgram = pname;
+      homepage = "https://github.com/wkillerud/some-sass";
+      license = with lib.licenses; [isc];
+    };
   }

packages/trash-d/default.nix

@@ -1,4 +1,5 @@
 {
+  lib,
   dmd,
   dub,
   trash-d-src,
@@ -36,7 +37,6 @@ in
 
       ronn --roff --pipe MANUAL.md > $out/man/man1/trash.1
     '';
-
     meta = {
       mainProgram = "trash";
       platforms = [
@@ -44,5 +44,8 @@ in
         "i686-linux"
         "x86_64-darwin"
       ];
+      description = "A near drop-in replacement for `rm` that uses the [FreeDesktop trash bin](https://specifications.freedesktop.org/trash-spec/trashspec-latest.html).";
+      homepage = "https://github.com/rushsteve1/trash-d";
+      license = with lib.licenses; [mit];
     };
   }