Repository files navigation

Gittyup is a graphical Git client designed to help you understand and manage your source code history. Thelatest stable releaseis available either as pre-built flatpak for Linux, 32 / 64 binary for Windows, macOS,or can be built from source by following the directionsbelow.

Thelatest development version is available pre-built as well.

Gittyup is a continuation of theGitAhead client.

• Features
• How to Get Help
• Build Environment
• Dependencies
• How to Build
• How to Install
  • Flatpak from terminal
• How to Contribute
• License

To get an overview of the current features please have a look at theGitHub Page

Ask questions about building or using Gittyup onStack Overflow byincluding thegittyup tag. Remember to search for existing questionsbefore creating a new one.

Report bugs in Gittyup by opening an issue in theissue tracker.Remember to search for existing issues before creating a new one.

If you still need help, check out our Matrix channelGittyup:matrix.org.

• C++11 compiler
  • Windows - MSVC >= 2017 recommended
  • Linux - GCC >= 6.2 recommended
  • macOS - Xcode >= 10.1 recommended
• CMake >= 3.3.1
• Ninja (optional)

External dependencies can be satisfied by system libraries or installedseparately. Included dependencies are submodules of this repository. Somesubmodules are optional or may also be satisfied by system libraries.

External Dependencies

• Qt (required >= 5.12)

Included Dependencies

• libgit2 (required)
• cmark (required)
• git (only needed for the credential helpers)
• libssh2 (needed bylibgit2 for SSH support)
• openssl (needed bylibssh2 andlibgit2 on some platforms)

Note that buildingOpenSSL on Windows requiresPerl andNASM.

Initialize Submodules

git submodule initgit submodule update --depth 1

Build OpenSSL

# Start from root of gittyup repo.cd dep/openssl/openssl

Windows:

perl Configure VC-WIN64Anmake

macOS (Intel):

./Configure darwin64-x86_64-cc no-sharedmake

macOS (Apple Silicon)

./Configure darwin64-arm64-cc no-sharedmake

Linux:

./config -fPICmake

Configure Build

# Start from root of gittyup repo.mkdir -p build/releasecd build/releasecmake -G Ninja -DCMAKE_BUILD_TYPE=Release ../..

If you have Qt installed in a non-standard location, you may have tospecify the path to Qt by passing-DCMAKE_PREFIX_PATH=<path-to-qt>where<path-to-qt> points to the Qt install directory that containsbin,lib, etc.

Build

    ninja

The easiest way to install Gittyup is by usingFlatpak.

Arch Linux

Install thegittyup package from the Arch User Repository.

git clone https://aur.archlinux.org/gittyup.gitcd gittyupmakepkg -si

Or use an AUR helper.Installgittyup-git for the VCS build.

Homebrew

Install thegittyup cask fromHomebrew.

brew install gittyup

If you want a more pure console use, this script run flatpak version disowning the process and silence the output pushing it to /dev/null.Just save the script somewhere in your path, for example/usr/bin (or~/.local/bin if you have exported it), give execution permissionschmod +x, and rungittyup from your terminal.

#!/bin/bashDIR=$(dirname"${BASH_SOURCE[0]}")functionrun_disown() {"$@"&disown}functionrun_disown_silence(){    run_disown"$@"1>/dev/null2>/dev/null}run_disown_silence flatpak run com.github.Murmele.Gittyup

We welcome contributions of all kinds, including bug fixes, new features,documentation and translations. By contributing, you agree to releaseyour contributions under the terms of the license.

Contribute by following the typicalGitHub workflowfor pull requests. Fork the repository and make changes on a new namedbranch. Create pull requests against themaster branch. Follow theseven guidelines to writing agreat commit message.

Prior to committing a change, please usecl-fmt.sh to ensure your codeadheres to the formatting conventions for this project. You can also use thesetup-env.sh script to install a pre-commit hook which will automaticallyrunclang-format against all modified files.

Prior to pushing a change, please ensure you run the unit tests to avoid anyregressions. These are found in<build-dir>/test and can be run usingctest.

Gittyup and its predecessor GitAhead are licensed under the MIT license. See LICENSE.md for details.