X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=INSTALL;h=3429f244a4f7f9d2989bfd7608e78ae4774f0741;hp=a9dc9e2b3762f09c08761550cc03812099ac1768;hb=2f3e8eee76e73ba48581509a9fd95b87f45ded48;hpb=84cd3561e97167ffb98ecab0fd2b884ba1d13ada diff --git a/INSTALL b/INSTALL index a9dc9e2b..3429f244 100644 --- a/INSTALL +++ b/INSTALL @@ -26,15 +26,15 @@ 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: -- gcc 4.7+ (available for most platforms), or -- Clang 3.2+ (available for most platforms, or -- XCode 4.6+ (available for Max OS X and based on Clang), or -- Visual C++ 2013 (available for Windows™), or +- 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 -Furthermore, CMake 2.8.9 or later is required. +Furthermore, CMake 2.8.9 or later is required (2.8.12 for KDE Frameworks). -As Quassel is a Qt application, you need the Qt SDK, either Qt 4.6+ or Qt 5.2+. +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. @@ -58,7 +58,7 @@ First of all, it is highly recommended for any CMake-based project to be built in a separate build directory rather than in-source. That way, your source checkout remains pristine, and you can easily remove any build artifacts by just deleting the build directory. This directory can be located anywhere; in the -short example above, we just created a directory called "build" inside the +short example above, we've just created a directory called "build" inside the source checkout. From inside the build directory, you can then run the "cmake" command, followed @@ -80,19 +80,35 @@ options here: things may happen. -DWITH_KDE=ON - Enable integration into KDE4; only available if -DUSE_QT5=OFF + Enable integration into KDE4 (with Qt4) or KDE Frameworks (with Qt5). --DWITH_OXYGEN=(ON|OFF) - Install the parts of the Oxygen icon set Quassel uses. Oxygen is the default - icon set for KDE4, and thus already available on systems where KDE4 is - installed. By default, WITH_OXYGEN is ON iff WITH_KDE is OFF. If you are +-DWITH_BREEZE=(ON|OFF) + Install the parts of the Breeze icon theme Quassel uses. Breeze is the default + icon theme for Plasma 5, and thus already available on systems where Plasma is + installed. By default, WITH_BREEZE is ON iff WITH_KDE is OFF. If you are sure that you have the icon set already installed on your system regardless, use this option to disable installing the bundled icons. +-DWITH_BREEZE_DARK=(ON|OFF) + Alternative icon theme to Breeze, optimized for dark desktop themes. + By default, WITH_BREEZE_DARK is OFF. + +-DWITH_OXYGEN=(ON|OFF) + Alternative icon theme to Breeze. Oxygen was the default theme in KDE 4, and + also the bundled icon theme in Quassel before version 0.13. + By default, WITH_OXYGEN is OFF. + +-DWITH_WEBENGINE=(ON|OFF) + 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. + -DWITH_WEBKIT=OFF - Use Webkit for showing previews of webpages linked in the chat. Requires - the QtWebkit module to be available, and increases the client's RAM usage + Use WebKit for showing previews of webpages linked in the chat. Requires + the QtWebKit module to be available, and increases the client's RAM usage by *a lot* if enabled at runtime. + Note that WebKit support is deprecated and mostly unmaintained in Qt, and + should no longer be used for security reasons. The default is OFF. -DEMBED_DATA=(ON|OFF) Specifies whether Quassel's data files (icons, translations and so on)