Skip to content

Latest commit

 

History

History
136 lines (102 loc) · 3.65 KB

BUILD.md

File metadata and controls

136 lines (102 loc) · 3.65 KB
Raw

How to Build Klogg

Overview

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. TODO: not yet 100% updated for klogg-io

Dependencies

  • cmake 3.12 or later to generate build files
  • C++ compiler with C++14 support (gcc 5, clang 3.4, msvc 2017)
  • Qt libraries 5.9 or later:
    • QtCore
    • QtGui
    • QtWidgets
    • QtConcurrent
    • QtNetwork
    • QtXml
    • QtTest
    • QtSerialPort
  • curl on Mac\Linux to build sentry (or switch to none in cmake options)
  • nsis to build windows installer (optional)

All other dependencies are provided in 3rdparty directory.

Getting the Source

This project is hosted on GitHub. You can clone this project directly using this command:

git clone https://github.com/variar/klogg

Building

Building on Linux

Here is how to build klogg on Ubuntu 18.04.

Install dependencies:

sudo apt-get install build-essential cmake qtbase5-dev libcurl4-openssl-dev

Configure and build klogg:

cd <path_to_klogg_repository_clone>
mkdir build_root
cd build_root
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
cmake --build .

Binaries are placed into build_root/output.

See .github/workflows/ci-build.yml for more information on build process.

Building on Windows

Install Microsoft Visual Studio 2017 or 2019 with C++ support. Community edition can be downloaded from Microsoft.

Intall latest Qt version using online installer. Make sure to select version matching Visual Studio installation. 64-bit libraries are recommended.

Install CMake from Kitware. Use version 3.14 or later for Visual Studio 2019 support.

Prepare build environment for CMake. Open command prompt window and depending on version of Visual Studio run either

call "%ProgramFiles(x86)%\Microsoft Visual Studio\2019\Community\Common7\Tools\vsdevcmd" -arch=x64

or

call "%ProgramFiles(x86)%\Microsoft Visual Studio\2017\Community\Common7\Tools\vsdevcmd" -arch=x64

Next setup Qt paths:

<path_to_qt_installation>\bin\qtenv2.bat

Then add CMake to PATH:

set PATH=<path_to_cmake_bin>:$PATH

Configure klogg solution (use CMake generator matching Visual Studio version):

cd <path_to_project_root>
md build_root
cd build_root
cmake -G "Visual Studio 16 2019 Win64" -DCMAKE_BUILD_TYPE=RelWithDebInfo ..

CMake should generate klogg.sln file in <path_to_project_root>\build_root directory. Open solution and build it.

Binaries are placed into build_root/output.

Building on Mac OS

Klogg requires macOS High Sierra (10.13) or higher.

Install Homebrew using terminal:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Homebrew installer should also install xcode command line tools.

Download and install build dependencies:

brew install cmake ninja qt

Usually path to qt installation looks like /usr/local/Cellar/qt/5.14.0/lib/cmake/Qt5

Configure and build klogg:

cd <path_to_klogg_repository_clone>
mkdir build_root
cd build_root
cmake -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DQt5_DIR=<path_to_qt_install> ..
cmake --build .

Binaries are placed into build_root/output.

Running tests

Tests are built by default. To turn them off pass -DBUILD_TESTS:BOOL=OFF to cmake. Tests use catch2 (bundled with klogg sources) and require Qt5Test module. Tests can be run using ctest tool provider by CMake:

cd <path_to_klogg_repository_clone>
cd build_root
ctest --build-config RelWithDebInfo --verbose