Skip to content

Simplify README setup and feature descriptions - #112

Merged
debpalash merged 1 commit into
mainfrom
docs/readme-clarity
Oct 2, 2026
Merged

debpalash merged 1 commit into
mainfrom
docs/readme-clarity

Conversation

@debpalash

Copy link
Copy Markdown
Owner

The README made installation choices and core features hard to scan. This edit cuts visible prose by about 42%, puts Get Opal into a concise install table, and shortens every text section while preserving all screenshots and GIF previews.

It also documents the verified v0.8.8 AUR libtorrent ABI mismatch and recommends AppImage, and makes the Zig 0.16.x source-build requirement explicit.

Validation:

  • zig build test: passed, 0 failures.
  • python3 tests/test_features.py: 481 passed, 0 failed, 2 warnings, 13 skipped.
  • Local links, image references, HTML details, and git diff --check: passed.
  • Existing README-related playback-version and phone-pairing checks: passed. Documentation only; no runtime behavior or new tests.

Signed-off-by: debpalash <4178343+debpalash@users.noreply.github.com>
@debpalash
debpalash merged commit 134bf58 into main Oct 2, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant