Go to file

Tony Crisci 2bbea06093 readme: change running instructions		2017-11-16 15:59:12 -05:00
backend	Merge pull request #422 from emersion/scan-build-fixes	2017-11-16 06:54:49 -05:00
dist/archlinux	Update README et al with new links	2017-10-02 22:27:39 -04:00
examples	Add scale parameter to wlr_cursor_set_image	2017-11-11 17:27:44 +01:00
include	Refactor rootston keyboard	2017-11-16 16:13:23 +01:00
protocol	Add server-decoration skeleton	2017-10-24 21:56:18 +02:00
render	Pass backend to render	2017-10-22 10:39:23 +13:00
rootston	Various keyboard fixes	2017-11-16 18:58:33 +01:00
types	Fix a bunch of mistakes detected with scan-build	2017-11-16 10:30:54 +01:00
util	Rename remaining refs to wlr_list	2017-10-21 22:02:36 -04:00
xcursor	Add FreeBSD compatibility	2017-10-11 00:07:21 +03:00
xwayland	Run startup command after xwayland is ready	2017-11-12 16:01:48 -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
dummy.c	Fix build on systems without systemd	2017-08-13 08:21:57 -04:00
glgen.sh	Fix glgen to be more POSIX corformant	2017-10-09 12:28:20 +13:00
meson.build	Load xwm cursor from theme	2017-11-02 15:52:02 +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.