wlroots/README.md

58 lines
1.3 KiB
Markdown
Raw Normal View History

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