diff --git a/README.md b/README.md index a1d5630..76e5718 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ the man pages for [cagebreak](man/cagebreak.1.md) and cagebreak Cagebreak is based on [Cage](https://github.com/Hjdskes/cage), a Wayland kiosk compositor. +Cagebreak is currently being developed under arch linux and uses the libraries +as they are obtained through pacman. However, cagebreak should also work on +other distributions given the proper library versions. + ## Installation ### Obtaining Source Code @@ -32,6 +36,11 @@ There are corresponding methods of verifying you obtained the correct code: ### Building Cagebreak +You can build Cagebreak with the [meson](https://mesonbuild.com/) build system. It +requires wayland, wlroots and xkbcommon to be installed. Note that Cagebreak is +developed against the latest tag of wlroots, in order not to constantly chase +breaking changes as soon as they occur. + Simply execute the following steps to build Cagebreak: ``` @@ -59,17 +68,6 @@ within an existing X11 or Wayland session, it will open in a virtual output as a window in your existing session. If you run it in a TTY, it'll run with the KMS+DRM backend. For more configuration options, see the man pages. -## Experimenting with Cagebreak - -Cagebreak is currently being developed under arch linux and uses the libraries -as they are obtained through pacman. However, cagebreak should also work on -other distributions given the proper library versions. - -You can build Cagebreak with the [meson](https://mesonbuild.com/) build system. It -requires wayland, wlroots and xkbcommon to be installed. Note that Cagebreak is -developed against the latest tag of wlroots, in order not to constantly chase -breaking changes as soon as they occur. - ## Contributing to Cagebreak Cagebreak is currently developed to fit the needs of its creators. Should you desire