Install from Source

If you are unsure about a step have a look at the CI config and if you still need help, feel free to start a discussion on GitHub.

Prerequisites

The following tools/libraries need to be installed.

Build Tools

• CMake >= 3.26
• A modern C++ compiler with c++17 support (g++, Clang and MSVC have been tested)

Libraries

The application depends on a few libraries which can either be installed through a package manager or compiled from source:

• Qt >= 6.5
• QtKeychain
• TagLib
• Poppler-Qt
• One of the following markdown libraries:
  • cmark-gfm
  • discount
• Quazip

Optional

Optionally librespot is required if you want to play music from Spotify.

Build

Download the source code using git:

git clone https://github.com/philinthegaps/gm-companion
cd gm-companion
git submodule update --init --recursive

Create a build directory:

mkdir build
cd build

Run cmake:

cmake .. -D CMAKE_INSTALL_PREFIX=install -D CMAKE_BUILD_TYPE=Release
cmake --build . --config Release --parallel
cmake --install . --config Release

Run install/bin/gm-companion.