README.md 1.16 KB
Newer Older
1
# wlroots
Drew DeVault's avatar
Drew DeVault committed
2

Drew DeVault's avatar
Drew DeVault committed
3
4
Pluggable, composable modules for building a
[Wayland](http://wayland.freedesktop.org/) compositor.
Drew DeVault's avatar
Drew DeVault committed
5

6
This is a WIP: [status](https://github.com/swaywm/wlroots/issues/9)
Drew DeVault's avatar
Drew DeVault committed
7
8
9

## Contributing

10
See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md)
11
12
13
14
15
16
17
18
19
20
21
22
23

## Building

Install dependencies:

* wayland
* wayland-protocols
* EGL
* GLESv2
* DRM
* GBM
* libinput
* udev
24
* pixman
25
* systemd (optional, for logind support)
Dudemanguy's avatar
Dudemanguy committed
26
* elogind (optional, for logind support on systems without systemd)
Scott Anderson's avatar
Scott Anderson committed
27
* libcap (optional, for capability support)
28
29
30
31
* asciidoc (optional, for man pages)

Run these commands:

Jan Kelling's avatar
Jan Kelling committed
32
33
    meson build
    ninja -C build
unrelentingtech's avatar
unrelentingtech committed
34
35

(On FreeBSD, you need to pass an extra flag to prevent a linking error: `meson build -D b_lundef=false`)
Tony Crisci's avatar
Tony Crisci committed
36
37
38
39
40
41
42
43
44
45

## 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

46
47
48
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)
49
file.