blankie
/
wlroots
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #426 from acrisci/feature/readme-running 

readme: add basic running doc
This commit is contained in:
Drew DeVault 2017-11-16 16:17:52 -05:00 committed by GitHub
parent bfcbe99cd5 2bbea06093
commit 10f3be7384
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -33,3 +33,17 @@ Run these commands:
ninja -C build ninja -C build
(On FreeBSD, you need to pass an extra flag to prevent a linking error: `meson build -D b_lundef=false`) (On FreeBSD, you need to pass an extra flag to prevent a linking error: `meson build -D b_lundef=false`)
## 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
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)
file.