From a446f735aea6f294bc75a1675f191521d45ed2d0 Mon Sep 17 00:00:00 2001 From: Tony Crisci Date: Thu, 16 Nov 2017 15:39:48 -0500 Subject: [PATCH 1/2] readme: add basic running doc --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 0f221e3c..721265ae 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,25 @@ Run these commands: ninja -C build (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 + +Run windows on the compositor with the display variable set: + +```bash +# run gtk apps like this +gnome-calculator --display=wayland-0 + +# run QT apps like this +qgit -platform wayland + +# run X11 apps like this +DISPLAY=:1 firefox +``` From 2bbea060937dd8ab99be2a4878c837298343f02a Mon Sep 17 00:00:00 2001 From: Tony Crisci Date: Thu, 16 Nov 2017 15:59:12 -0500 Subject: [PATCH 2/2] readme: change running instructions --- README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 721265ae..06ef8dcb 100644 --- a/README.md +++ b/README.md @@ -43,15 +43,7 @@ After building, run rootston from a terminal or VT with: ./build/rootston/rootston -Run windows on the compositor with the display variable set: - -```bash -# run gtk apps like this -gnome-calculator --display=wayland-0 - -# run QT apps like this -qgit -platform wayland - -# run X11 apps like this -DISPLAY=:1 firefox -``` +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.