build: Add Boost 1.0 license for CMake script

[quassel.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 1ad90c3..2d5d58d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -23,20 +23,20 @@ Prerequisites
 -------------
 
 Of course, for building Quassel you need the usual set of build tools, for
-example a compiler. As we use a subset of the C++11 standard, we require a
-fairly recent compiler:
+example a compiler. The codebase uses the C++14 standard, so a reasonably recent
+compiler is needed:
 
-- gcc 4.8+ (available for most platforms), or
-- Clang 3.3+ (available for most platforms), or
-- XCode 5.0+ (available for Max OS X and based on Clang), or
-- Visual C++ 2015 (available for Windows™), or
-- any other compiler with decent C++11 support
+- GCC 5.0+ (available for most platforms), or
+- Clang 3.4+ (available for most platforms), or
+- XCode 6.0+ (available for Max OS X and based on Clang), or
+- MSVC 19+ (part of Visual Studio 2017 on Windows™)
 
-Furthermore, CMake 2.8.9 or later is required (2.8.12 for KDE Frameworks).
+Other compilers may work, but are not officially supported.
 
-As Quassel is a Qt application, you need the Qt SDK, either Qt 4.8+ or Qt 5.2+.
-
-There are several optional dependencies; we will talk about that later.
+As Quassel is a Qt application, you need the Qt SDK, version 5.5 or higher.
+Furthermore, the Boost header-only libraries (at least version 1.56) and
+CMake 3.5 or later are required. CMake will tell you about any missing
+dependencies when configuring the project.
 
 Compiling Quassel - short version
 ---------------------------------
@@ -74,13 +74,14 @@ options here:
 -DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF)
     Choose which Quassel binaries to build.
 
--DUSE_QT4=ON
-    Build against the deprecated Qt4 instead of the default Qt5. Note that you
-    should empty your build directory when switching between Qt versions,
-    otherwise weird things may happen.
+-DUSE_CCACHE=ON
+    Enable ccache if the ccache binary is available. This avoids the need for
+    hacks using PATH or the CXX variable to make ccache work.
+    Distributors may want to disable automatic detection if they have their
+    own caching mechanism set up.
 
 -DWITH_KDE=ON
-    Enable integration into KDE4 (with Qt4) or KDE Frameworks (with Qt5).
+    Enable integration with the KDE Frameworks runtime environment
 
 -DWITH_BUNDLED_ICONS=ON
     Quassel requires a number of icons that are part of the KDE/Plasma icon themes
@@ -96,12 +97,12 @@ options here:
     Support the Oxygen icon theme. Oxygen was the default theme in KDE 4, and
     also the bundled icon theme in Quassel before version 0.13. Since the move
     to Qt5, the more modern Breeze icon theme is preferred, and thus Oxygen
-    is disabled by default when building against Qt5.
+    is disabled by default.
 
 -DWITH_WEBENGINE=ON
     Use WebEngine for showing previews of webpages linked in the chat. Requires
     the QtWebEngine module to be available, and increases the client's RAM usage
-    by *a lot* if enabled at runtime. Only available for Qt5. The default is ON.
+    by *a lot* if enabled at runtime. The default is ON.
 
 -DWITH_WEBKIT=OFF
     Use WebKit for showing previews of webpages linked in the chat. Requires