diff --git a/CMakeLists.txt b/CMakeLists.txt index 27cd35814..e4dc2f658 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,64 @@ +################################################################# +# +# For license of this file, see /LICENSE.md. +# +# This is RSS Guard compilation script for cmake. +# +# Usage (out of source build type, we have two side by side folders: +# empty "build-dir" and RSS Guard repository "rssguard-dir"): +# a) DEBUG build for testing. +# cd build-dir +# cmake -DCMAKE_BUILD_TYPE="Debug" ../rssguard-dir/ +# cmake --build . +# cmake --install . +# +# b) RELEASE build for production use. +# cd build-dir +# cmake -DCMAKE_BUILD_TYPE="Release" ../rssguard-dir/ +# cmake --build . +# cmake --install . +# +# Variables: +# USE_WEBENGINE - if specified, then QtWebEngine module for internal web browser is used. +# Otherwise simple text component is used and some features will be disabled. +# Default value is "false". If QtWebEngine is installed during compilation, then +# value of this variable is tweaked automatically. +# {FEEDLY,GMAIL,INOREADER}_CLIENT_ID - preconfigured OAuth cliend ID. +# {FEEDLY,GMAIL,INOREADER}_CLIENT_SECRET - preconfigured OAuth cliend SECRET. +# +# Other information: +# - supports Windows, Linux, macOS, OS/2, Android, +# - Qt 5.9.0 or newer is required, +# - cmake 3.9.0 or newer is required, +# - if you wish to make packages for Windows, then you must initialize all submodules within repository before compilation, +# - C++ 11/17 is required. +# +# Building on OS/2: +# RSS Guard can run on OS/2 and if you want to compile it by yourself, you need to make sure that +# your OS/2 distro is up-to-date and you have all dependencies installed: os2-base, all gcc-* packages, +# libc and libcx up-to-date, kbuild-make, ash, binutils, all relevant qt5-* packages. +# +# After your dependecies are installed, then you can compile via standard `qmake -> make -> make install` steps +# and package with: 7z.exe a -t7z -mmt -mx9 "rssguard.7z" "