Core Wayland window system code and protocol
Find a file
Pekka Paalanen 3cfdd56af4 contributing: review rules for bugs
Half of the ideas came from Daniel but most of them are reworded, the
rest are my thoughts.

Mention compiler warnings specifically, and be more explicit on what
kind of code or bugs or bug fixes are acceptable or not. Clarify commit
scope.

v2: move the "In a patch series" rule to the bottom, reworded.

Cc: Daniel Stone <daniels@collabora.com>
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Daniel Stone <daniels@collabora.com>
Reviewed-by: Derek Foreman <derek.foreman.samsung@gmail.com>
2018-07-13 11:19:12 -05:00
cursor cursor: add forward declaration for struct wl_buffer 2017-12-04 19:45:38 +00:00
doc doc: update IANA MIME types registry URL 2018-06-28 14:13:13 +03:00
egl wayland-egl: Ignore underscored symbols in ABI check 2018-03-20 10:01:19 -05:00
m4 Clean up .gitignore files 2010-11-11 20:11:27 -05:00
protocol tests: Check for wrong fd delivery with zombie objects 2018-01-09 15:20:00 +00:00
spec doc: move documentation from the tex file to docbook 2012-03-28 23:04:25 -04:00
src client: remove definition of wl_global 2018-06-28 14:35:40 +03:00
tests tests: Add free-without-remove test 2018-04-20 13:19:13 -05:00
.gitignore .gitignore: add wayland-egl-abi-check 2018-04-02 11:01:33 -05:00
.gitlab-ci.yml .gitlab-ci.yml: collect the distcheck error logs 2018-06-18 12:17:11 +03:00
autogen.sh Update autotools configuration 2010-11-06 21:04:03 -04:00
configure.ac doc: Update URLs for GitLab transition 2018-06-11 12:03:39 +03:00
CONTRIBUTING.md contributing: review rules for bugs 2018-07-13 11:19:12 -05:00
COPYING COPYING: Update to MIT Expat License rather than MIT X License 2015-06-12 15:31:21 -07:00
Makefile.am doc: move Contributing 2018-06-14 14:39:47 +03:00
publish-doc publish-doc: Add script for publishing docs to the website 2015-05-27 15:34:20 -07:00
README doc: Update URLs for GitLab transition 2018-06-11 12:03:39 +03:00
TODO Update TODO 2012-10-21 20:53:37 -04:00
wayland-scanner.m4 scanner: check for wayland-scanner.pc before using variables 2013-08-07 16:25:10 -07:00
wayland-scanner.mk Pass input/output files as arguments to wayland-scanner 2017-08-18 15:20:24 +03: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 application, 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.

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

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

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