mirror of
https://github.com/cage-kiosk/cage.git
synced 2025-10-29 05:40:19 -04:00
61 lines
2.5 KiB
Markdown
61 lines
2.5 KiB
Markdown
# Cage: a Wayland kiosk
|
|
|
|
<img src="https://www.hjdskes.nl/img/projects/cage/cage.svg" alt="Cage's logo" width="150px" align="right">
|
|
|
|
This is Cage, a Wayland kiosk. A kiosk runs a single, maximized
|
|
application.
|
|
|
|
This README is only relevant for development resources and instructions. For a
|
|
description of Cage and installation instructions for end-users, please see
|
|
[its project page](https://www.hjdskes.nl/projects/cage) and [the
|
|
Wiki](https://github.com/cage-kiosk/cage/wiki/).
|
|
See [the man page](./cage.1.scd) for a list of possible environment variables and run options.
|
|
|
|
## Release signatures
|
|
|
|
Releases up to version 0.1.4 are signed with [6EBC43B1](http://keys.gnupg.net/pks/lookup?op=vindex&fingerprint=on&search=0x37C445296EBC43B1). Releases from 0.1.5 onwards are signed with
|
|
[E88F5E48](https://keys.openpgp.org/search?q=34FF9526CFEF0E97A340E2E40FDE7BE0E88F5E48)
|
|
All releases are published on [GitHub](https://github.com/cage-kiosk/cage/releases).
|
|
|
|
## Building and running Cage
|
|
|
|
You can build Cage with the [meson](https://mesonbuild.com/) build system. It
|
|
requires wayland, wlroots, and xkbcommon to be installed. Optionally, install
|
|
scdoc for manual pages. Cage is currently based on branch 0.18 of wlroots.
|
|
|
|
Simply execute the following steps to build Cage:
|
|
|
|
```
|
|
$ meson setup build
|
|
$ meson compile -C build
|
|
```
|
|
|
|
By default, this builds a debug build. To build a release build, use `meson
|
|
setup build --buildtype=release`.
|
|
|
|
Cage comes with compile-time support for XWayland. To enable this, make sure
|
|
that your version of wlroots is compiled with this option. 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
|
|
<kbd>Alt</kbd>+<kbd>Esc</kbd> to quit. For more configuration options, see
|
|
[Configuration](https://github.com/cage-kiosk/cage/wiki/Configuration).
|
|
|
|
Cage is based on the annotated source of tinywl and rootston.
|
|
|
|
## Bugs
|
|
|
|
For any bug, please [create an
|
|
issue](https://github.com/cage-kiosk/cage/issues/new) on
|
|
[GitHub](https://github.com/cage-kiosk/cage).
|
|
|
|
## License
|
|
|
|
Please see
|
|
[LICENSE](https://github.com/cage-kiosk/cage/blob/master/LICENSE) on
|
|
[GitHub](https://github.com/cage-kiosk/cage).
|
|
|
|
Copyright © 2018-2020 Jente Hidskes <dev@hjdskes.nl>
|