mirror of
https://github.com/hyprwm/wlroots-hyprland.git
synced 2024-11-02 11:55:59 +01:00
Merge pull request #426 from acrisci/feature/readme-running
readme: add basic running doc
This commit is contained in:
commit
10f3be7384
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
@ -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.
|
||||||
|
|
Loading…
Reference in a new issue