Remit client in Qt

What does it do?

Show you remit and github side-by-side, so you can review comfortably.

Why a third client?

Because the other two only work on macOS and one bold developer had to use Linux.

Setting things up

Note

This flow isn't ideal. There's an issue to build a Dialog that prompts for Remit's URL and Token.

1. Run qt-remit. The left pane will show an example page. That's fine, we'll fix that later.
2. Log into Github in the right pane
3. Close qt-remit
4. Find the config file and set the Remit URL and token. qt-remit uses QStandardPaths::AppConfigLocation
   • on macOS, the file is at ~/Library/Preferences/qt-remit/config.ini
   • on Linux, the file is at ~/.config/qt-remit/config.ini
5. Open qt-remit again
6. Go to the remit settings and click "Sign in with Github"

Build instructions

Setup Dependencies

You need

• A C++ compiler
• CMake
• Qt Libraries

macOS

The quickest way is

xcode-select --install # Installs the xcode tools, including git and a C++ compiler. If you used git to clone this repo, you can skip this line
brew install cmake
brew install qt # Installs a full set of Qt libraries, including all of the ones qt-remit needs

Ubuntu, with apt

sudo apt install build-essential cmake
sudo apt install libqt6webenginewidgets6 # Should pull in everything else as dependencies

If you're on a different distro that doesn't package Qt in a comparable way, check the Windows section below for how to install Qt from the online installer.

Report from joakimk:

On Linux with Qt 6.6.3 this worked: Custom Installation -> Qt -> 6.6.3 -> gcc, Qt WebEngine. Keep CMake in Build Tools. sudo apt install libglx-dev libgl1-mesa-dev. Then follow "Building qt-remit" below.

Windows

Install the Build Tools for Visual Studio.

Install Qt through the Qt OSS online installer.

At the time of writing, the latest version is 6.9.1. The WebEngine part may have moved since then (it also moved between 6.6 and 6.9)

Do a custom installation and make sure you install

• Extensions -> Qt WebEngine -> Qt 6.9.1
• Qt -> 6.9.1 -> Desktop
• Qt -> Build Tools -> CMake 3.30.5 (the version doesn't matter)

Building qt-remit

1. Clone the repository
2. Create a folder for the build output.
3. cmake -S path/to/qt-remit/ -O path/to/build/folder
4. cd into the build output folder
5. make

This should generate a binary you can put somewhere on your path and run, as long as it can find a Qt6 that has the WebEngineWidgets installed.

Packaging qt-remit

On macOS, the build steps above produce an application package without an icon. Drop that into your /Applications folder to have it available from your launcher of choice.

On Windows, the build steps produce a self-contained binary without an icon. Drop that wherever you want to execute it from and set up a link.

Is it any good?

Yes.