summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 14 insertions, 2 deletions
diff --git a/README b/README
index 3247a2547..e32485040 100644
--- a/README
+++ b/README
@@ -1,5 +1,17 @@
-This is the Qt for Wayland module.
+This is the QtWayland module.
+
+The QtWayland module consists of two parts:
+
+Wayland platform plugin:
+ Enables Qt applications to be run as Wayland clients.
+
+QtCompositor API:
+ Enables the creation of Wayland compositors using Qt and QtQuick.
+
+To build the QtWayland module you need the external dependencies:
+xkbcommon 0.2.0 - http://xkbcommon.org/
+libwayland 1.0.1 - http://wayland.freedesktop.org/
-Sometimes we are slightly behind upstream wayland, so if your compiling Wayland from git, reset to sha1 defined in wayland_sha1.txt
We hang out at #qt-labs and #qt-lighthouse on freenode if you have any questions
+