Skip to content

docs: lead the README with the app, not the badges #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gitgusilva merged 1 commit into from
Jul 28, 2026
Merged

docs: lead the README with the app, not the badges #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# GitBox
<h1 align="center">
<img src="images/logo.png" width="64" align="middle" alt="" />
&nbsp;GitBox
</h1>

<p align="center">
<img src="images/logo.png" width="128" alt="GitBox Logo" />
A fast, self-contained Git GUI built with Vue 3, Electron and a C++ addon over libgit2.<br />
No <code>git</code> binary required — clone, fetch, pull and push run natively over HTTPS and SSH.
</p>

[![stars](https://img.shields.io/github/stars/gitgusilva/gitbox.svg)](https://github.com/gitgusilva/gitbox/stargazers)
[![forks](https://img.shields.io/github/forks/gitgusilva/gitbox.svg)](https://github.com/gitgusilva/gitbox/forks)
[![license](https://img.shields.io/github/license/gitgusilva/gitbox.svg)](LICENSE)
[![latest](https://img.shields.io/github/v/release/gitgusilva/gitbox.svg)](https://github.com/gitgusilva/gitbox/releases/latest)
[![downloads](https://img.shields.io/github/downloads/gitgusilva/gitbox/total)](https://github.com/gitgusilva/gitbox/releases)
<p align="center">
<a href="https://github.com/gitgusilva/gitbox/releases/latest"><img src="https://img.shields.io/github/v/release/gitgusilva/gitbox.svg" alt="Latest release" /></a>
<a href="https://github.com/gitgusilva/gitbox/releases"><img src="https://img.shields.io/github/downloads/gitgusilva/gitbox/total" alt="Downloads" /></a>
<a href="https://github.com/gitgusilva/gitbox/stargazers"><img src="https://img.shields.io/github/stars/gitgusilva/gitbox.svg" alt="Stars" /></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/gitgusilva/gitbox.svg" alt="License" /></a>
</p>

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.
<p align="center">
<img src="site/public/screenshots/history.png" width="880" alt="GitBox showing a repository's commit history with the branch graph" />
</p>

## Features

Expand All @@ -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.
Expand Down