summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJørgen Lind <jorgen.lind@nokia.com>2011-12-05 17:09:02 +0100
committerLaszlo Agocs <laszlo.p.agocs@nokia.com>2011-12-07 09:58:35 +0100
commit4c89518228012ddc3602eab405e4b5fb8108fcdf (patch)
tree615d4fdc38999e408d52998c39760064d223b652 /README
parent542eca71e074b5110df2aaf822449bf7d6ec2b91 (diff)
Make wayland actually a module
Also fix so that QtCompositor can be built as shared object. + fix so that the default QT_WAYLAND_GL_CONFIG is wayland_egl Change-Id: I02b72e99286584426bd37ab2d00bbc84af11efdc Reviewed-by: Laszlo Agocs <laszlo.p.agocs@nokia.com>
Diffstat (limited to 'README')
-rw-r--r--README88
1 files changed, 3 insertions, 85 deletions
diff --git a/README b/README
index ce4bc7cad..3247a2547 100644
--- a/README
+++ b/README
@@ -1,87 +1,5 @@
-This document is heavily inspired by the Building Wayland document:
-http://wayland.freedesktop.org/building.html
+This is the Qt for Wayland module.
-However, it is slightly more messy
-:) If you encounter things you find unclear, and know of a better way of
-expressing it, then please send a patch:)
+Sometimes we are slightly behind upstream wayland, so if your compiling Wayland from git, reset to sha1 defined in wayland_sha1.txt
-Qt-Compositor is meant as a toolbox for making new funky Wayland compositors.
-
-Pre-requisites on Linux (apt-get): git, autoconf, automake, libtool, libexpat1-dev
-Pre-requisites on Mac OSX Snow Leopard: git, latest Gnu autoconf, latest Gnu automake, latest Gnu libtool, latest pkg-config.
-Make sure you have /usr/local/bin on the $PATH before /usr/bin
-
-1. To build wayland we need libffi + libffi headers on Linux. For Mac we need a special version of wayland/event-loop.c -- if you pull the distribution from the freedesktop.org, replace the event-loop.c with the one in this repo
-
-# sudo apt-get install libffi-dev
-On Mac ffi is part of the OS but you need to tell the the wayland configure
-export FFI_CFLAGS=-I/usr/include/ffi
-export FFI_LIBS-lffi
-
-Qt-Compositor contains a copy of the Wayland libraries. We have not changed
-them in any way, but they are provided for convenience so that you can compile
-everything using qmake. However, I suggest you use the official Wayland
-libraries. The only dependency they have is to ffi. The demos has some more
-dependencies, but we are not going to compile those.
-
-2. Clone Wayland from: git://anongit.freedesktop.org/wayland/wayland
-# git clone git://anongit.freedesktop.org/wayland/wayland
-
-3. Compile Wayland: ./autogen.sh -prefix=$HOME/install && make && make install
-
-4. Set your PKG_CONFIG_PATH so that the location of the Wayland libraries are
-picked up by Qt's configure.
-# export PKG_CONFIG_PATH=$HOME/install/lib/pkgconfig/
-
-6. Set the library path to pick up the Wayland libraries
-# export LD_LIBRARY_PATH=$HOME/install/lib
-
-8. Get the build dependencies that you need for QtGui.
-# sudo apt-get build-dep libqt4-gui
-
-One of the dependencies that the wayland-demos compositor and client
-applications has is xkbcommon. The Qt-Lighthouse wayland plugin has code to
-read xkbcommon codes sent over the wayland protocol, so that Qt-Lighthouse
-clients on Wayland will get keyboard functionality in other compositors.
-However, Qt-Compositor doesn't have this requirement. The support for xkbcommon
-is picked up by configure. If it is not detected the Wayland plug-in will be
-compiled with the: QT_NO_WAYLAND_XKB.
-
-libxkbcommon is available from: git://people.freedesktop.org/xorg/lib/libxkbcommon.git
-Use typically the following line to configure it:
-# ./autogen.sh --prefix=$HOME/install --with-xkb-config-root=/usr/share/X11/xkb
-
-Its a good idea to use out of source builds when building Qt. A good setup
-could be: $HOME/dev/qt-src/lighthouse where lighthouse is where you have a
-complete checkout of the lighthouse repository. Then you can have ie.:
-$HOME/dev/qt-builds/lighthouse-debug
-
-9. Clone Lighthouse from gitorious
-# git clone git@gitorious.org:+qt-developers/qt/lighthouse.git
-# $HOME/dev/qt-src/lighthouse
-(you might want to use git remote etc. if you already have a clone of
-qt-master)
-
-10. Configure and compile Qt-Lighthouse. So from
-$HOME/dev/qt-builds/lighthouse-debug do: ../../qt-src/lighthouse/configure -qpa
--developer-build && make
-
-11. OK, now we have Lighthouse and Wayland libs on our system. To try Wayland
-out we want the compositor to render into a XWindow(this is for development).
-So we need to compile up a X back-end for lighthouse. They don't get built
-automatically (yet). The Wayland plug-in will be ma
-
-Go into the directory: $HOME/dev/qt-src/lighthouse/src/plugins/platforms/xcb
-# make
-
-12. When this is done, you are ready to compile the qwidget-compositor. Enter
-the directory with $QT-COMPOSITOR-DIR/examples/qwidget-compositor #qmake &&
-make
-
-Makes generates a executable in $QT-COMPOSITOR-DIR/bin. Execute it and pass in
--platform xcb
-# $QT-COMPOSITOR-DIR/bin/qt-compositor -platform xcb
-
-This should give you a blank window. If you now open a another terminal with
-LD_LIBRARY_PATH set and run a simple Qt example with the -platform Wayland, it
-should render into this window.
+We hang out at #qt-labs and #qt-lighthouse on freenode if you have any questions