Development Linux

Linux development environment

This page is for building KLog from source for development. If you just want to run KLog, see Installation on Linux instead (a distribution package or pre-built binary is usually simpler).

Requirements

KLog requires Qt6 to build. Many distributions still default to an older Qt version, so you may need to install Qt6 packages explicitly.

Build dependencies (package names vary by distribution — look for equivalents): cmake, qt6-tools-dev-tools, qt6-base-dev, libqt6charts6-dev, qt6-serialport-dev, libhamlib++-dev, qmake6, libqt6sql6-sqlite, libhamlib-dev, qt6-location-dev, qt6-positioning-dev, qt6-l10n-tools, qt6-declarative-private-dev, qt6-tools-dev.

Runtime dependencies (needed to run a self-built KLog, installed automatically if you use the Debian package instead): libqt6serialport6, libqt6sql6-sqlite, qml6-module-qtlocation, qml6-module-qtquick-window, qml6-module-qtquick, qml6-module-qtquick-controls, qt6-location-plugins.

Verify Qt6 is available:

qmake6 -v

The output should report Qt version 6.x, for example:

QMake version 3.1
Using Qt version 6.4.2 in /usr/lib/x86_64-linux-gnu

Build steps

1. Get the sources:

   git clone https://github.com/ea4k/klog.git
   cd klog
   

   (or unpack a klog-<version>.tar.gz release tarball and cd into it).

2. Configure the build (creates a build directory):

   cmake -S . -B build
   

3. Build:

   cmake --build build
   

   The klog executable will be produced inside the build folder.

4. Install system-wide (optional, run as root):

   sudo cmake --install build --prefix /usr
   

Run ./build/klog (or just klog if installed) to start it.

Tests

KLog includes tests under the tests folder, built and run the same way as any other Qt/CMake test target. New functionality should include appropriate tests before it is released.

See Development Notes for general contribution guidelines.