Repository navigation
Rewrite the README as a short fork summary with screenshots - #64
Merged
Merged
Conversation
The README had grown to 462 lines of per-feature rationale, and had still fallen behind: nothing on the GIP driver rework or headphone audio through Xbox pads, the rebuilt browse screen, the keystroke soft keyboard, or the worst-frame and sparkline overlay, and the OkHttp and BouncyCastle versions were stale. The detail lives in the PR descriptions and commit messages; the README now says what the fork is, what it changes, in a line or two per item, and what was removed, then how to build and test it. The credits block keeps every upstream, xow and backported-PR link the old file had; the upstream store links go, since they never pointed at this fork's builds. Six screenshots under docs/screenshots/, taken on the Shield streaming Steam from Sunshine: browse, settings, the in-stream menu and two of its submenus, and the overlay cropped to its own region. WebP at q90, 232 KB in total against 776 KB as PNG/JPEG, and GitHub renders WebP in a README. Latency and performance impact: none. Documentation and images only; no code, resources or build configuration change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Focus on the rail so Add PC and Settings show their labels, and with Steam still running on the host the tile carries its running badge, which the earlier shot did not show. Latency and performance impact: none, image only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Anything with Android 11 and an ARM CPU can run the build; naming the Shield and the Homatics read as a device whitelist. The Amlogic decoder line stays, since that is a decoder family the code checks by name. Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Thirteen items in one paragraph read as a wall; one per line scans. Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
HARDWARE_TESTING.md has recorded it as verified on hardware since 2026-08-24; the README caveat was stale on arrival. Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The branch that moves the toolchain from 25 to 26 is in flight; the README is being rewritten in parallel, so it states the version it will be true for when both land rather than one that would be stale on merge. Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Latency and performance impact: none, documentation only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
trexx
force-pushed
the
docs/readme-rewrite
branch
from
September 16, 2026 16:24
288a3fa to
4fd842e
Compare
trexx
marked this pull request as ready for review
September 16, 2026 21:14
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Rewrites
README.mdfrom 462 lines of per-feature rationale to a 193-line summary of what the fork is, what it changes (a line or two per item), what it removed, and how to build and test it. Adds six screenshots underdocs/screenshots/.Why
The long-form README was hard to scan and had fallen behind — nothing on the GIP driver rework or Xbox-pad headphone audio, the rebuilt browse screen, the keystroke soft keyboard, the worst-frame/sparkline overlay or the build label, and OkHttp/BouncyCastle versions were stale. The rationale lives in the PR descriptions and commit messages.
Screenshots
Taken on the Shield TV (
com.limelight.unofficial12.1) streaming Steam from Sunshine, over adb: browse, settings, in-stream menu, special-keys and controllers submenus, and the performance overlay cropped to its own region. WebP q90, 232 KB total (776 KB as PNG/JPEG); GitHub renders WebP in READMEs.Credits
Every upstream author, xow, summershrimp and backported-PR link from the old file is kept in the Credits section. Upstream's Play/Amazon/F-Droid links are dropped — they never pointed at this fork's builds — in favour of one link to moonlight-stream.org.
Latency / performance impact
None. Documentation and images only.
🤖 Generated with Claude Code