Update INSTALL for WebEngine/WebKit
authorManuel Nickschas <sputnick@quassel-irc.org>
Wed, 7 Sep 2016 23:40:09 +0000 (01:40 +0200)
committerManuel Nickschas <sputnick@quassel-irc.org>
Wed, 4 Apr 2018 21:14:02 +0000 (23:14 +0200)
WebEngine is a new feature, and WebKit is deprecated and unmaintained.
Update INSTALL to reflect the changes.

(cherry picked from commit 342b2df76f0a2a9e0bf234c681c3072a56216e14)

Conflicts:
    INSTALL

INSTALL

diff --git a/INSTALL b/INSTALL
index d4e3920..58b3159 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -89,11 +89,25 @@ options here:
     sure that you have the icon set already installed on your system regardless,
     use this option to disable installing the bundled icons.
 
     sure that you have the icon set already installed on your system regardless,
     use this option to disable installing the bundled icons.
 
+-DWITH_BREEZE=(ON|OFF)
+    Alternative icon set to Oxygen.
+    By default, WITH_BREEZE is OFF.
+
+-DWITH_BREEZE_DARK=(ON|OFF)
+    Alternative icon set to Oxygen.
+    By default, WITH_BREEZE_DARK 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
 -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
-    by *a lot* if enabled at runtime. Note also that Webkit frequently crashes
-    especially on Windows.
+    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)
 
 -DEMBED_DATA=(ON|OFF)
     Specifies whether Quassel's data files (icons, translations and so on)