Go to file
emersion c6aab6f56c
Add docs and comments
2018-01-21 11:11:25 +01:00
backend output: add damage tracking via buffer age 2018-01-21 00:06:35 +01:00
examples output: add damage tracking via buffer age 2018-01-21 00:06:35 +01:00
include Add docs and comments 2018-01-21 11:11:25 +01:00
protocol Add idle protocol 2018-01-10 14:32:41 +02:00
render output: add damage tracking via buffer age 2018-01-21 00:06:35 +01:00
rootston Add docs and comments 2018-01-21 11:11:25 +01:00
types output: add damage tracking via buffer age 2018-01-21 00:06:35 +01:00
util Allow configurable verbosity 2017-12-31 14:50:19 -07:00
xcursor output: add wlr_output::damage, fixes #572 2018-01-18 19:47:21 +01:00
xwayland xwayland: render children window in fullscreen 2018-01-14 18:19:37 +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 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 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 meson: fix include path in generated .pc 2018-01-04 23:41:44 +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.