From 6f99201371ef2121cb43df3261041db0710db34c Mon Sep 17 00:00:00 2001
From: Gustavo Will <48598429+gitgusilva@users.noreply.github.com>
Date: Mon, 27 Jul 2026 23:15:35 -0300
Subject: [PATCH] docs: lead the README with the app, not the badges
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
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
— 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.
---
README.md | 28 +++++++++++++++++++---------
1 file changed, 19 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index d35a43e..aae9b69 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,23 @@
-# GitBox
+
+
+ GitBox
+
-
+ A fast, self-contained Git GUI built with Vue 3, Electron and a C++ addon over libgit2.
+ No git binary required — clone, fetch, pull and push run natively over HTTPS and SSH.
-[](https://github.com/gitgusilva/gitbox/stargazers)
-[](https://github.com/gitgusilva/gitbox/forks)
-[](LICENSE)
-[](https://github.com/gitgusilva/gitbox/releases/latest)
-[](https://github.com/gitgusilva/gitbox/releases)
+
+
+
+
+
+
-A fast, self-contained Git GUI built with Vue 3, Electron and a C++ addon over libgit2.
-No `git` binary required: clone, fetch, pull and push run natively, over HTTPS and SSH.
+
+
+
## Features
@@ -37,6 +43,10 @@ The AppImage and the Windows installer update themselves from GitHub Releases;
libgit2 and its TLS stack, so there is nothing else to install — a local Git is
not required.
+The Linux packages are built on Ubuntu 22.04, so they need glibc 2.35 or newer
+(Ubuntu 22.04+, Debian 12+, Fedora 36+, RHEL 9+). SSH remotes (`git@…`) work on
+Linux; the Windows build authenticates over HTTPS for now.
+
## Building from source
Requires Node.js 20+, npm, a C++ toolchain (gcc/clang or MSVC), CMake, Ninja and Perl.