Go to file

emersion e6d2e72401 Remove display destroy listeners, add compositor listener		2017-12-07 00:44:45 +01:00
backend	Fix segfault when moving hardware cursor	2017-12-05 22:23:01 +01:00
dist/archlinux	Update README et al with new links	2017-10-02 22:27:39 -04:00
examples	Moved os-compatibility and added header	2017-11-30 18:01:13 +01:00
include	Remove display destroy listeners, add compositor listener	2017-12-07 00:44:45 +01:00
protocol	Add server-decoration skeleton	2017-10-24 21:56:18 +02:00
render	Use correct include path for glapi.h	2017-11-30 10:32:55 +13:00
rootston	Add display destroy listener in screenshooter, destroy display in rootston	2017-12-07 00:13:06 +01:00
types	Remove display destroy listeners, add compositor listener	2017-12-07 00:44:45 +01:00
util	Moved os-compatibility and added header	2017-11-30 18:01:13 +01:00
xcursor	Add FreeBSD compatibility	2017-10-11 00:07:21 +03:00
xwayland	xwayland: remove xwayland param from xsurface methods	2017-12-03 17:30:57 -05:00
.build.yml	Fix CI build	2017-11-02 00:19:51 +01:00
.editorconfig	Add XML rules to .editorconfig	2017-10-15 22:21:05 +02:00
.gitignore	add configuration file	2017-08-26 08:32:11 -04:00
.travis.yml	Fix CI build	2017-11-02 00:19:51 +01:00
CONTRIBUTING.md	Update README et al with new links	2017-10-02 22:27:39 -04:00
LICENSE	Initial commit	2017-04-25 11:32:52 -04:00
README.md	readme: change running instructions	2017-11-16 15:59:12 -05:00
glgen.sh	Change glapi.sh to generate both files	2017-11-22 14:04:29 +13:00
meson.build	Add minimum meson version	2017-11-22 12:05:44 +13:00
meson_options.txt	Make xwayland compile-time optional	2017-10-06 21:50:25 +00:00

README.md

wlroots

Pluggable, composable modules for building a Wayland compositor.

This is a WIP: status

Contributing

See CONTRIBUTING.md

Building

Install dependencies:

wayland
wayland-protocols
EGL
GLESv2
DRM
GBM
libinput
udev
pixman
systemd (optional, for logind support)
elogind (optional, for logind support on systems without systemd)
libcap (optional, for capability support)
asciidoc (optional, for man pages)

Run these commands:

meson build
ninja -C build

(On FreeBSD, you need to pass an extra flag to prevent a linking error: meson build -D b_lundef=false)

Running the Reference Compositor

wlroots comes with a reference compositor called rootston that demonstrates the features of the library.

After building, run rootston from a terminal or VT with:

./build/rootston/rootston

Now you can run windows in the compositor from the command line or by configuring bindings in your rootston.ini file.