docs: rework client/crate READMEs, add missing ones

Rework the client READMEs to be accurate and inviting to first-time
visitors, and fill in the gaps where crates and tools had none.

- Rewrite clients/{apple,android,decky} READMEs (features-first, trim
  dense internal narrative; drop the stale "one session at a time" /
  "renegotiation not implemented" section from the Apple README).
- Add READMEs for clients/{linux,windows,probe}, which had none.
- Add crate READMEs for punktfunk-host, punktfunk-core, pf-driver-proto.
- Add brief READMEs for tools/{loss-harness,latency-probe}.
- Fix packaging/README duplicate "Option B" heading (bootc -> Option C).
- Fix docs-site/README stale docs/ -> design/ reference.
- De-stale packaging/windows/drivers/pf-dualsense README (drop "M0 spike"
  / external-checkout framing; reflect in-tree workspace + shipped +
  installer-bundled + multi-pad), keeping the driver-authoring lore.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

This commit is contained in:

Enrico Bühler

2026-07-01 19:31:06 +00:00

parent 184fb0203f

commit 78e74f6ceb

14 changed files with 624 additions and 585 deletions

									
										packaging/README.md
									
		+1
		-1
	
												View File
												
				@@ -73,7 +73,7 @@ rpm-ostree install punktfunk && systemctl reboot

				   systemctl reboot

				   ```

				## Option B — bootc (image-based, atomic)

				## Option C — bootc (image-based, atomic)

				Layer punktfunk into a Bazzite image once, then rebase any number of hosts onto it — no

				per-host drift. See `bootc/Containerfile`: