unom/punktfunk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 17 Wiki Activity

docs: update README + docs site for public readiness

Browse Source 
Refresh the README and documentation for public visitors:

- README: public-facing rewrite with accurate status for all four native
  clients (macOS, Linux, Windows, Android) and the Windows host.
- docs site: fix stale client status (Android is a full client, not a
  scaffold; Windows client is stage-1 complete + signed MSIX), add the
  missing Android client section, correct "which client" guidance.
- Windows host: corrected from "deferred/scoped" to implemented & shipping
  (NVIDIA-only, x64-only) across windows-host, roadmap, status,
  requirements, running-as-a-service, and the README.
- Remove internal infrastructure from public docs (box names, private IPs,
  SSH/token commands, deploy topology); rewrite status.md as a public
  project-status page; sanitize ci.md and implementation-plan.md.
- Update clients/android and clients/apple READMEs to current state.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Enrico Bühler
2026-06-20 18:59:01 +02:00
parent 24dc8ee60b
commit 0be3183cf2
21 changed files with 447 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs-site/content/docs/configuration.md
+4 -4
View File
@@ -30,15 +30,15 @@ These tell the host which desktop session to attach to. Your setup guide sets th
You don't set these on the host — **the client chooses them**. When a device connects, the host
creates a virtual display at that device's resolution and refresh rate. A 1080p60 laptop and a
1440p120 desktop each get their own. (With Moonlight, set the mode in Moonlight's settings; with the
Apple app, it uses the device's display.)
1440p120 desktop each get their own. (With Moonlight, set the mode in Moonlight's settings; the
native clients let you pick a mode or default to the device's display.)
## Bitrate
The client requests a bitrate; the host encodes to it. To find a good value for your link:
- **Apple app:** use the built-in **speed test** (a host card's menu → *Test Network Speed*). It
measures your link and suggests a bitrate, then applies it.
- **Native clients (Apple, Linux, and more):** use the built-in **speed test** (from a host's menu).
It measures your link, suggests a bitrate, and applies it.
- **Moonlight:** set the bitrate in Moonlight's settings. Start moderate and raise it.
## Multiple devices at once