Update README.md, add CONTRIBUTING.md

This commit is contained in:
Drew DeVault 2017-06-06 10:54:53 -04:00
parent 6298351d83
commit d79f578022
2 changed files with 230 additions and 2 deletions

View file

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