export gsf package and hardware.gsf nixos module

2026-03-25 10:28:31 +00:00
parent d359a2048f
commit af9f3e3567
4 changed files with 182 additions and 2 deletions
@@ -84,7 +84,36 @@ Default speed stats path:

 For NixOS notes, see `DEV_SETUP.md`.

-## systemd user service
+## nixos module
+
+This flake now exports:
+
+- `packages.<system>.default` (contains `gsf` + `gsfd`)
+- `nixosModules.default` (`hardware.gsf`)
+
+Example:
+
+```nix
+# flake input
+inputs.gsf.url = "github:<you>/gotta-scroll-fast";
+
+# module import + config
+{
+  imports = [ inputs.gsf.nixosModules.default ];
+
+  hardware.gsf = {
+    enable = true;
+    device = "/dev/input/by-id/usb-...-event-mouse";
+    inputGroupUsers = [ "thomasgl" ];
+    # extraArgs = [ "--match-name" "ploopy" ];
+  };
+}
+```
+
+`hardware.gsf` intentionally does **not** provide declarative accel parameters.
+Manage those via your dotfiles (`~/.config/gsf/config.json`) and `gsf` CLI/TUI.
+
+## systemd user service (manual alternative)

 A starting unit file exists at: