summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAndy Nichols <andy.nichols@digia.com>2012-11-30 13:52:00 +0100
committerAndy Nichols <andy.nichols@digia.com>2012-12-03 09:50:54 +0100
commitc2651cb953c4dfcf1578a380e65d6a0ec20ca571 (patch)
treee5be70e6caafaafc7c9e93d1162d6d298d5c4775 /README
parent9a8b92cc314aa84652c6da00129bb35f4a05a561 (diff)
downloadqtwayland-c2651cb953c4dfcf1578a380e65d6a0ec20ca571.tar.gz
Cleanup QtWayland module
Now that both xkbcommon 0.2.0 and libWayland 1.0.0 have been released, we should no longer be building against sha1's and should be preparing for an eventual release so these build hints have been removed. A test has been added for libWayland 1.0.0 which is required to build QtWayland. README has been updated to reflect the current situation src/3rdparty has been removed as it has not been used in some time. patches folder and contents have been removed as they are no longer needed. extensions folder has been moved to the src folder Change-Id: Iab79b5c164758a4bd0253c90f60b2a2d044e2785 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com> Reviewed-by: Samuel Rødal <samuel.rodal@digia.com>
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 14 insertions, 2 deletions
diff --git a/README b/README
index 3247a254..e3248504 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
+