aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 26 insertions, 2 deletions
diff --git a/README.md b/README.md
index 74a2385e..75d191d4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,29 @@
# wlroots
-A set of utility libraries for Wayland compositors.
+Pluggable, composable modules for building a Wayland compositor.
-WIP
+WIP - [Status](https://github.com/SirCmpwn/wlroots/issues/9)
+
+## Building
+
+Install dependencies:
+
+* cmake
+* wayland
+* wayland-protocols
+* EGL
+* GLESv2
+* DRM
+* GBM
+* libinput
+* udev
+* systemd (optional, for logind support)
+* asciidoc (optional, for man pages)
+
+Run these commands:
+
+ mkdir build
+ cd build
+ cmake -DCMAKE_BUILD_TYPE=Release ..
+ make
+ sudo make install