Building, installing and using

⚠️ This page is work in progress ⚠️

Requirements

The following software is required to build the project:

• Git client
• CMake
• A C++ compiler which supports C++11, GCC and CLang are the only compilers supported right now
• Platform dependent threads implementation
• zlib
• OpenSSL*

The following software is recommended to build the project:

• Python
• Standard C library specific Network Information Service (NIS) implementation
• libpng
• libjpeg-turbo*
• libtiff
• libmng
• nas
• iconv
• CUPS
• Freetype
• Fontconfig
• ICU
• glib
• DBus
• GTK (v2)
• GConf (v2)
• Platform dependent EGL implementation
• Platform dependent OpenGL implementation
• UnixODBC*
• PostgreSQL
• MySQL*
• Sqlite
• Resolv (part of the standard C library)

*The software mentioned has know alternative(s) which is also supported, such as LibreSSL which is almost a drop-in replacement for OpenSSL or MariaDB as an alternative to MySQL.

Building

• Learn how to take advantage of the flexible build system
• If size matters build with MinSizeRel as CMAKE_BUILD_TYPE, LTO and no exceptions
• If time and disk space for building matters build with KATIE_ALLINONE set to ON
• Create packages via cpack, make package or a native package via the provided package files for various distributions

Debian

TODO

Arch Linux

TODO

other UNIX-like system

TODO

Using

• Watch out for tools/scripts that alter environmental variables (e.g. sudo) such as LD_LIBRARY_PATH, PKG_CONFIG_PATH
• On Windows Katie_DIR must point to the cmake subdirectory of the Katie installation path (e.g. C:\Program Files\Katie\cmake) otherwise it will not be found by applications that use CMake and want to build against Katie
• ...