init

README.md

@@ -0,0 +1,49 @@
+100% slopcoded
+
+---
+
+A KDE Plasma 6 applet (panel icon) to toggle [voxtype](https://voxtype.io) voice typing on and off.
+
+## Prerequisites
+
+[voxtype](https://voxtype.io) must be installed and its daemon running. The applet reads state from `/run/user/1000/voxtype/state` and checks for the daemon via `/run/user/1000/voxtype/pid` — the same locations used by the voxtype GNOME extension.
+
+## What this does
+
+- Shows a panel icon reflecting the current voxtype state.
+- Click to toggle recording on/off (sends `voxtype record toggle` when the daemon is running).
+- Polls the state file periodically to update the icon and tooltip.
+- Icons change by state: idle, recording, transcribing, or not-running.
+
+## How to use it
+
+### Nix Flake + Home Manager
+
+Add the flake to your `flake.nix` inputs:
+
+```nix
+voxtype-toggle = {
+  url = "https://git.eversole.co/James/voxtype-toggle-plasmashell.git";
+  inputs.nixpkgs.follows = "nixpkgs";
+};
+```
+
+Then pass it through `extraSpecialArgs` and install the applet into `xdg.dataFile`:
+
+```nix
+{
+  voxtype-toggle,
+  system,
+  # ... other args
+}:
+
+# In extraSpecialArgs:
+extraSpecialArgs = { inherit voxtype-toggle system; };
+
+# In your home-manager module:
+xdg.dataFile."plasma/plasmoids/org.eversole.voxtype-toggle" = {
+  source = "${voxtype-toggle.packages.${system}.plasmaAppletVoxtypeToggle}/share/plasma/plasmoids/org.eversole.voxtype-toggle";
+};
+```
+
+This copies the applet files to the standard KDE Plasma applet directory (`~/.local/share/plasma/plasmoids/`) so the applet is available immediately after `home-manager switch` — no manual symlink or copy step needed.