Skip to content

docs: screenshots in the README - #40

Open
vynulldev wants to merge 1 commit into
mainfrom
readme-screenshots
Open

vynulldev wants to merge 1 commit into
mainfrom
readme-screenshots

Conversation

@vynulldev

Copy link
Copy Markdown
Owner

What & why

The site has had screenshots since launch, but the repo README, the first thing anyone landing on GitHub sees, was text-only: badges, an intro paragraph, and straight into caveats. This adds the web UI hero shot right after the intro, with the track-detail and live-players captures side by side under it, so the first screenful shows the product.

The images are the same captures vynull.dev uses, checked into assets/ so the README is self-contained rather than hotlinking the site. They're resized from 2960px to 1800px wide (GitHub renders README content at ~890 CSS px, so 1800 covers 2x displays) and encoded as WebP q90, which takes the three images from 2.3MB of PNG to 476KB with no visible loss on UI content; the palette-PNG alternative came out 3x larger. The theme shots stay out of the repo, with a link to the site's gallery instead.

Documentation and images only; no code changes.

Hardware testing

  • Tested on: N/A: README and image assets only, no code change.

Checklist

  • go build ./..., go vet ./..., and go test ./... pass
  • gofmt -l . is clean
  • New source files carry an SPDX header (GPL-3.0-or-later) (n/a, no new source files)
  • Tested on real hardware (deck + firmware noted above), or this change doesn't affect deck behaviour
  • I agree my contribution is licensed under the project's GPLv3

@vynulldev vynulldev added the documentation Improvements or additions to documentation label Sep 21, 2026
@vynulldev
vynulldev marked this pull request as ready for review October 2, 2026 19:54
The site has had screenshots since launch but the repo README - the
first thing anyone landing on GitHub sees - was text-only. Add the
web UI hero shot plus track-detail and live-players side by side,
the same captures vynull.dev uses, served from assets/ so the README
is self-contained; the site's gallery is linked for the theme shots
rather than growing the repo further.

The captures are resized from 2960px to 1800px wide (GitHub renders
README content at ~890 CSS px, so 1800 covers 2x displays) and
encoded as WebP q90, taking the three images from 2.3MB of PNG to
480KB with no visible loss on UI content.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant