docs(readme): add Screenshots gallery + drop Download section (#54 E)#161
Conversation
Closes the last sub-item of #54 (E: README screenshots) and trims the heavy Download block now that per-release notes carry the install flow (one-liners + standalone bundles + Gatekeeper / SmartScreen caveats) so each version stays self-contained. - New `## Screenshots` section before Features, with six curated captures in a 2x3 HTML table: home, library albums, album detail, immersive Now Playing, karaoke lyrics, Wrapped year-in-review. Table is wrapped in `markdownlint-disable MD033` / `enable` blocks with a comment explaining why HTML beats Markdown here (no clean 2-column image grid with captions in plain Markdown). - Replace the Download section (Linux distro one-liners, Windows winget + installers, macOS Gatekeeper notes, auto-update caveat) with a single "Install" line under the intro pointing at the latest GitHub release — keeps the README on-brand and lets the release notes own the version-specific install matrix. Screenshots committed to `docs/screenshots/` at the captured 1920x1080 PNGs as shot by the maintainer. Only the six used files are tracked (the other two from the same batch — `now-playing.png` and `wrapped-first-page.png` — were redundant with the kept set).
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughLa section d'installation du README est consolidée vers la page "Latest release" et one-liners par OS; une section "Screenshots" en grille deux colonnes a été ajoutée. Les instructions par package/OS et le paragraphe sur les auto-updates ont été supprimés. ChangesMise à jour de la documentation du projet
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…nced `wrapped.png` is a portrait story-style capture, the other five screenshots in the gallery are landscape. Rendered at 50 % column width, the portrait tile stretched roughly 3× taller than the karaoke-lyrics tile next to it, leaving a lot of empty whitespace around the landscape and visually dwarfing the rest of the row. Inline `max-height: 520px; width: auto;` keeps the aspect ratio and brings the rendered height in line with its row partner. `align=center` on the cell pulls the now-smaller image to the middle of the column instead of letting it hug the left edge.
GitHub's markdown sanitizer drops inline `style` attributes (including the `max-height` we set in #161), so the portrait Wrapped capture rendered at its full natural size after the merge — the gallery row ended up even more imbalanced than before the cap. The HTML `height` attribute is in GitHub's allowlist and the browser keeps the aspect ratio when only one dimension is set, so `height="380"` brings the Wrapped tile to roughly the same rendered height as the landscape karaoke-lyrics tile next to it without any CSS.
Closes the last sub-item of #54.
Changes
New Screenshots section before Features — six 2×3 captures in an HTML table:
Table wrapped in localised `markdownlint-disable MD033` comments with a one-line rationale, because Markdown has no clean 2-column image grid with captions.
Drop `## Download` — moved by maintainer into the per-release notes so each version owns its install matrix (one-liners + standalone bundles + Gatekeeper / SmartScreen caveats). README keeps a single `Install` line under the intro pointing at the latest release.
Notes
Six PNGs committed to `docs/screenshots/` at 1920×1080 as shot. Two other captures from the same batch (`now-playing.png`, `wrapped-first-page.png`) were dropped — redundant with the kept set.
Test plan
Summary by CodeRabbit