Go to file
2012-10-21 10:04:17 -04:00
cursor Move ARRAY_LENGTH out of public headers 2012-10-19 17:08:38 -04:00
doc doc: Update doxygen documentation when source files are changed 2012-10-19 16:50:38 -04:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol protocol: try to clarify wl_buffer doc 2012-10-16 11:06:51 -04:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src scanner: Fix valgrind errors 2012-10-20 11:38:57 -04:00
tests tests: Include wayland-private.h for container_of 2012-10-21 10:04:17 -04:00
.gitignore man: add man-page infrastructure 2012-09-25 11:02:52 -04:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac configure: Depend on a more strict version of publican 2012-10-19 16:51:38 -04:00
COPYING Add COPYING 2012-04-25 10:12:21 -04:00
Makefile.am configure: Make documentation option work in fact 2012-10-15 13:10:08 -04:00
README README: Update 2012-07-20 12:20:20 -04:00
TODO protocol: Add transform argument to wl_output.geometry event 2012-07-22 15:50:37 -04:00
wayland-scanner.m4.in Split into a core repository that only holds the core Wayland libraries 2011-02-14 22:21:13 -05:00
wayland-scanner.mk Split into a core repository that only holds the core Wayland libraries 2011-02-14 22:21:13 -05:00

What is Wayland

Wayland is a project to define a protocol for a compositor to talk to
its clients as well as a library implementation of the protocol.  The
compositor can be a standalone display server running on Linux kernel
modesetting and evdev input devices, an X applications, or a wayland
client itself.  The clients can be traditional applications, X servers
(rootless or fullscreen) or other display servers.

The wayland protocol is essentially only about input handling and
buffer management.  The compositor receives input events and forwards
them to the relevant client.  The clients creates buffers and renders
into them and notifies the compositor when it needs to redraw.  The
protocol also handles drag and drop, selections, window management and
other interactions that must go through the compositor.  However, the
protocol does not handle rendering, which is one of the features that
makes wayland so simple.  All clients are expected to handle rendering
themselves, typically through cairo or OpenGL.

The weston compositor is a reference implementation of a wayland
compositor and the weston repository also includes a few example
clients clients.

Building the wayland libraries is fairly simple, aside from libffi,
they don't have many dependencies:

    $ git clone git://anongit.freedesktop.org/wayland/wayland
    $ cd wayland
    $ ./autogen.sh --prefix=PREFIX
    $ make
    $ make install

where PREFIX is where you want to install the libraries.  See
http://wayland.freedesktop.org for more complete build instructions
for wayland, weston, xwayland and various toolkits.