2018-03-04 16:33:45 -05:00
|
|
|
# wlroots
|
2017-04-25 11:32:52 -04:00
|
|
|
|
2017-08-13 08:29:04 -04:00
|
|
|
Pluggable, composable modules for building a
|
|
|
|
|
[Wayland](http://wayland.freedesktop.org/) compositor.
|
2017-04-25 11:32:52 -04:00
|
|
|
|
2017-10-02 22:27:39 -04:00
|
|
|
This is a WIP: [status](https://github.com/swaywm/wlroots/issues/9)
|
2017-08-13 08:29:04 -04:00
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2017-10-02 22:27:39 -04:00
|
|
|
See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md)
|
2017-06-06 10:54:53 -04:00
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
Install dependencies:
|
|
|
|
|
|
|
|
|
|
* wayland
|
|
|
|
|
* wayland-protocols
|
|
|
|
|
* EGL
|
|
|
|
|
* GLESv2
|
|
|
|
|
* DRM
|
|
|
|
|
* GBM
|
|
|
|
|
* libinput
|
|
|
|
|
* udev
|
2017-08-09 16:24:28 +02:00
|
|
|
* pixman
|
2017-06-06 10:54:53 -04:00
|
|
|
* systemd (optional, for logind support)
|
2017-09-22 12:16:11 -05:00
|
|
|
* elogind (optional, for logind support on systems without systemd)
|
2017-07-04 00:29:03 +12:00
|
|
|
* libcap (optional, for capability support)
|
2017-06-06 10:54:53 -04:00
|
|
|
* asciidoc (optional, for man pages)
|
|
|
|
|
|
|
|
|
|
Run these commands:
|
|
|
|
|
|
2017-07-17 20:38:28 +02:00
|
|
|
meson build
|
|
|
|
|
ninja -C build
|
2017-10-10 01:23:43 +03:00
|
|
|
|
|
|
|
|
(On FreeBSD, you need to pass an extra flag to prevent a linking error: `meson build -D b_lundef=false`)
|
2017-11-16 15:39:48 -05:00
|
|
|
|
|
|
|
|
## 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
|
|
|
|
|
|
2017-11-16 15:59:12 -05:00
|
|
|
Now you can run windows in the compositor from the command line or by
|
|
|
|
|
configuring bindings in your
|
|
|
|
|
[`rootston.ini`](https://github.com/swaywm/wlroots/blob/master/rootston/rootston.ini.example)
|
2018-03-04 16:33:45 -05:00
|
|
|
file.
|
