You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

58 lines
1.3 KiB

# wlroots [![](https://api.travis-ci.org/swaywm/wlroots.svg)](https://travis-ci.org/swaywm/wlroots)
Pluggable, composable modules for building a
[Wayland](http://wayland.freedesktop.org/) compositor.
This is a WIP: [status](https://github.com/swaywm/wlroots/issues/9)
## Contributing
See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/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
Run windows on the compositor with the display variable set:
```bash
# run gtk apps like this
gnome-calculator --display=wayland-0
# run QT apps like this
qgit -platform wayland
# run X11 apps like this
DISPLAY=:1 firefox
```