summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohan Klokkhammer Helsing <johan.helsing@theqtcompany.com>2016-03-31 09:48:46 +0200
committerJohan Helsing <johan.helsing@theqtcompany.com>2016-04-01 06:41:50 +0000
commitd4451028906f91267af6b5439b9798fb337823ca (patch)
tree0488287c8be27e503554c32946d51921fe6585ac /README
parentecde73e9f5aa2b5d26e1497332d045130e1b5ccf (diff)
downloadqtwayland-d4451028906f91267af6b5439b9798fb337823ca.tar.gz
Remove traces of obsolete config flag "wayland-compositor"
The compositor is always built regardless of this config flag. Consequently some of the documentation and configuration was contradicting and confusing. * Removes the mentions of the flag from the README * Always build compositor tests * Always build plugins Update readme Change-Id: I37b7d1f0250beb17780834928114ecefdf17684e Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@gmail.com>
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 4 insertions, 14 deletions
diff --git a/README b/README
index 5f18509b..7d9ed16b 100644
--- a/README
+++ b/README
@@ -5,26 +5,16 @@ The QtWayland module consists of two parts:
Wayland platform plugin:
Enables Qt applications to be run as Wayland clients.
-QtCompositor API:
+QtWaylandCompositor API:
Enables the creation of Wayland compositors using Qt and QtQuick.
-By default only the Wayland platform plugin is built. If you want to build the
-experimental QtCompositor API then you need to set the qmake CONFIG variable to
-include "wayland-compositor" when building the QtWayland module:
-
-qmake CONFIG+=wayland-compositor
-make
-
-Note: make sure the source tree is clean before running those commands. If in
-doubt, run git clean -f -d -x.
-
To build the QtWayland module you need the external dependencies:
xkbcommon 0.2.0 - http://xkbcommon.org/
wayland 1.6.0 - http://wayland.freedesktop.org/
-QtCompositor supports loading client buffer integrations that don't use the
-wayland-egl interfaces. These client buffer integrations are picked up by
-QtCompositor as plugins. To specify what plugin to load use the environment
+QtWaylandCompositor supports loading client buffer integrations that don't use
+the wayland-egl interfaces. These client buffer integrations are picked up by
+QtWaylandCompositor as plugins. To specify what plugin to load use the environment
variable QT_WAYLAND_CLIENT_BUFFER_INTEGRATION in the environment where the
compositor is started. The compositor will broadcast to the clients which
hardware integration to load when using the generic platformplugin "wayland". If