From d79f5780225d2416f3fff9dcebeac1d64110bb94 Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Tue, 6 Jun 2017 10:54:53 -0400 Subject: Update README.md, add CONTRIBUTING.md --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3