Go to file

Guido Günther c5aac77692 Fix some typos Prefer initialize over initialise since used more often in the sources.		2018-01-30 16:10:07 +01:00
backend	Fix some typos	2018-01-30 16:10:07 +01:00
examples	Backport screenshooter fixes from the renderer redesign v1	2018-01-23 22:06:54 +01:00
include	Merge pull request #580 from emersion/screenshooter-renderer-backport	2018-01-29 17:13:23 -05:00
protocol	Add idle protocol	2018-01-10 14:32:41 +02:00
render	Merge pull request #580 from emersion/screenshooter-renderer-backport	2018-01-29 17:13:23 -05:00
rootston	Merge pull request #580 from emersion/screenshooter-renderer-backport	2018-01-29 17:13:23 -05:00
types	Merge pull request #580 from emersion/screenshooter-renderer-backport	2018-01-29 17:13:23 -05:00
util	Allow configurable verbosity	2017-12-31 14:50:19 -07:00
xcursor	move get_resize_name to xcursor	2017-12-08 06:08:06 -05:00
xwayland	style: add else keywords in xwm.c	2018-01-21 17:04:23 +01:00
.build.yml	Fix CI build	2017-11-02 00:19:51 +01:00
.editorconfig	Add wlr_primary_selection_device_manager and wlr_primary_selection_source	2017-12-22 19:20:12 +01:00
.gitignore	Remove vim stuff from .gitignore	2018-01-26 10:06:07 -05:00
.travis.yml	travis: add job building wlroots without various options	2018-01-28 16:14:38 +00:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2017-12-27 10:39:53 -05: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	Fix some typos	2018-01-30 16:10:07 +01: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.