docs: lead the README with the app, not the badges - #3
Merged
Conversation
The header put "# GitBox" above a centred logo, so the name and the mark never sat together, and the badges hung left-aligned underneath. Put the logo and the name on one line (align="middle" inside a centred <h1> — the only form GitHub's sanitizer keeps, since it strips style) and centre the tagline and badges under it. Add a screenshot. Nine of them are already committed under site/public/screenshots and the README used none, which for a GUI is the whole pitch missing. Correct the SSH claim while here: the tagline promised native HTTPS and SSH, but the Windows build is USE_SSH=OFF, so say where SSH works. Also note the glibc floor the Linux packages inherit from the ubuntu-22.04 builder — the kind of detail issue #1 turned on. Drop the forks badge: no signal for a project this young.
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.
Logo and name on one line, centred tagline and badges, and the first screenshot the README has ever had — nine were already committed under
site/public/screenshotsand none were used, which for a GUI is the whole pitch missing.Two factual fixes rode along:
USE_SSH=OFF(documented inbuild-libgit2.ps1). Install now says SSH works on Linux and Windows authenticates over HTTPS for now.Also dropped the forks badge (no signal at this size) and skipped adding a CI badge on purpose: the workflows do not run on pushes to
main, so it would render "no status".No build runs on this PR by design — the
pathsfilter added in #2 keeps doc-only changes from packaging four installers. Worth eyeballing the rendered diff, since the header relies on what GitHub's HTML sanitizer keeps (alignon<img>/<h1>;styleis stripped).