mirrors/cage
1
0
Fork 0
mirror of https://github.com/cage-kiosk/cage.git synced 2025-10-29 05:40:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: update build instructions

Browse source
This commit is contained in:
Jente Hidskes 2020-02-01 16:17:58 +01:00
parent 66313efb01
commit e664fdce79
No known key found for this signature in database
GPG key ID: 04BE5A29F32D91EA
1 changed files with 11 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -7,8 +7,8 @@ application.
This README is only relevant for development resources and instructions. For a
description of Cage and installation instructions for end-users, please see
[the Wiki](https://github.com/Hjdskes/cage/wiki/) and [its project
page](https://www.hjdskes.nl/projects/cage).
[its project page](https://www.hjdskes.nl/projects/cage) and [the
Wiki](https://github.com/Hjdskes/cage/wiki/).
## Release signatures
@ -30,20 +30,21 @@ $ meson build
$ ninja -C build
```
By default, this builds a debug build. To build a release build, use `meson
build --buildtype=release`.
Cage comes with compile-time support for XWayland. To enable this,
first make sure that your version of wlroots is compiled with this
option. Then, add `-Dxwayland=true` to the `meson` command above. Note
that you'll need to have the XWayland binary installed on your system
for this to work.
You can run Cage by running `./build/cage APPLICATION`. If you run it
from 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 at
a TTY, it'll run with the KMS+DRM backend. In debug mode (default
build type with Meson), press Alt+Esc to quit. To build a release
build, use `meson build --buildtype=release`.
For more information, see the [Wiki](https://github.com/Hjdskes/cage/wiki).
You can run Cage by running `./build/cage APPLICATION`. If you run it from
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 at a TTY, it'll run with the
KMS+DRM backend. In debug mode (default build type with Meson), press
<kbd>Alt</kbd>+<kbd>Esc</kbd> to quit. For more configuration options, see
[Configuration](https://github.com/Hjdskes/cage/wiki/Configuration).
Cage is based on the annotated source of tinywl and rootston.