mirror of https://github.com/cage-kiosk/cage.git synced 2025-10-29 05:40:19 -04:00

A Wayland kiosk

Find a file

Jente Hidskes 907bb78c92 Add missing config.h.in		2019-01-02 22:28:56 +01:00
cage.c	Update copyright to include 2019	2019-01-02 21:01:01 +01:00
config.h.in	Add missing config.h.in	2019-01-02 22:28:56 +01:00
LICENSE	Update copyright to include 2019	2019-01-02 21:01:01 +01:00
meson.build	Add XWayland support	2019-01-02 20:58:48 +01:00
meson_options.txt	Add XWayland support	2019-01-02 20:58:48 +01:00
output.c	Output: abstract away a view switch statement	2019-01-02 21:23:16 +01:00
output.h	Refactor cage into separate source files	2018-12-31 00:12:33 +01:00
README.md	README: document XWayland compile-time option	2019-01-02 21:13:00 +01:00
seat.c	Seat: abstract away a view switch statement	2019-01-02 21:31:30 +01:00
seat.h	Add XWayland support	2019-01-02 20:58:48 +01:00
server.h	Add XWayland support	2019-01-02 20:58:48 +01:00
view.c	Seat: abstract away a view switch statement	2019-01-02 21:31:30 +01:00
view.h	Seat: abstract away a view switch statement	2019-01-02 21:31:30 +01:00
xdg_shell.c	Seat: abstract away a view switch statement	2019-01-02 21:31:30 +01:00
xdg_shell.h	Refactor cage into separate source files	2018-12-31 00:12:33 +01:00
xwayland.c	Seat: abstract away a view switch statement	2019-01-02 21:31:30 +01:00
xwayland.h	Add XWayland support	2019-01-02 20:58:48 +01:00

README.md

Cage: a Wayland kiosk

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.

Building and running Cage

You can build Cage with the meson build system. It requires wayland, wlroots and xkbcommon to be installed. Simply execute the following steps to build Cage:

$ meson build
$ ninja -C build

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.

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.

Cage is based on the annotated source of TinyWL.

Bugs

For any bug, please create an issue on GitHub.

License

Please see LICENSE on GitHub.