2019-04-20 14:57:07 +02:00
|
|
|
# Cage: a Wayland kiosk [](https://builds.sr.ht/~hjdskes?)
|
2018-11-22 19:59:06 +01:00
|
|
|
|
2019-04-24 20:57:10 +02:00
|
|
|
<img src="https://www.hjdskes.nl/img/projects/cage/cage.svg" alt="Cage's logo" width="150px" align="right">
|
2019-04-23 22:52:35 +02:00
|
|
|
|
2018-11-22 19:59:06 +01:00
|
|
|
This is Cage, a Wayland kiosk. A kiosk runs a single, maximized
|
|
|
|
|
application.
|
|
|
|
|
|
2020-01-26 16:03:05 +01:00
|
|
|
This README is only relevant for development resources and instructions. For a
|
|
|
|
|
description of Cage and installation instructions for end-users, please see
|
2020-02-01 16:17:58 +01:00
|
|
|
[its project page](https://www.hjdskes.nl/projects/cage) and [the
|
|
|
|
|
Wiki](https://github.com/Hjdskes/cage/wiki/).
|
2018-11-22 19:59:06 +01:00
|
|
|
|
2019-04-23 22:52:35 +02:00
|
|
|
## Release signatures
|
|
|
|
|
|
|
|
|
|
Releases are signed with
|
|
|
|
|
[6EBC43B1](http://keys.gnupg.net/pks/lookup?op=vindex&fingerprint=on&search=0x37C445296EBC43B1)
|
|
|
|
|
and published on [GitHub](https://github.com/Hjdskes/cage/releases).
|
|
|
|
|
|
2018-11-22 19:59:06 +01:00
|
|
|
## Building and running Cage
|
|
|
|
|
|
2019-02-26 18:33:48 +01:00
|
|
|
You can build Cage with the [meson](https://mesonbuild.com/) build system. It
|
2020-05-31 15:14:18 +02:00
|
|
|
requires wayland, wlroots, and xkbcommon to be installed. Optionally, install
|
|
|
|
|
scdoc for manual pages. Note that Cage is developed against the latest tag of
|
|
|
|
|
wlroots, in order to not constantly chase breaking changes as soon as they
|
|
|
|
|
occur.
|
2019-02-26 18:33:48 +01:00
|
|
|
|
|
|
|
|
Simply execute the following steps to build Cage:
|
2018-11-25 22:11:08 +01:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ meson build
|
|
|
|
|
$ ninja -C build
|
|
|
|
|
```
|
|
|
|
|
|
2020-02-01 16:17:58 +01:00
|
|
|
By default, this builds a debug build. To build a release build, use `meson
|
|
|
|
|
build --buildtype=release`.
|
|
|
|
|
|
2019-01-02 21:08:45 +01:00
|
|
|
Cage comes with compile-time support for XWayland. To enable this,
|
|
|
|
|
first make sure that your version of wlroots is compiled with this
|
2019-01-04 18:49:48 +01:00
|
|
|
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.
|
2019-01-02 21:08:45 +01:00
|
|
|
|
2020-02-01 16:17:58 +01:00
|
|
|
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).
|
2019-12-20 17:04:38 +01:00
|
|
|
|
2019-01-31 14:49:01 +01:00
|
|
|
Cage is based on the annotated source of tinywl and rootston.
|
2018-11-22 19:59:06 +01:00
|
|
|
|
|
|
|
|
## Bugs
|
|
|
|
|
|
|
|
|
|
For any bug, please [create an
|
|
|
|
|
issue](https://github.com/Hjdskes/cage/issues/new) on
|
|
|
|
|
[GitHub](https://github.com/Hjdskes/cage).
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Please see
|
|
|
|
|
[LICENSE](https://github.com/Hjdskes/cage/blob/master/LICENSE) on
|
|
|
|
|
[GitHub](https://github.com/Hjdskes/cage).
|
|
|
|
|
|
2020-01-11 16:46:18 +01:00
|
|
|
Copyright © 2018-2020 Jente Hidskes <dev@hjdskes.nl>
|
