readme: Include man page reference for command-line options and env vars

This commit is contained in:
Michal Vaniš 2024-11-02 17:13:20 +01:00
parent 7f9e2364e3
commit 57c9977144
No known key found for this signature in database
GPG key ID: 02C1636045748B36

View file

@ -9,6 +9,7 @@ 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
@ -20,7 +21,7 @@ All releases are published on [GitHub](https://github.com/cage-kiosk/cage/releas
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 (or see them [here](./cage.1.scd)). Cage is currently based on branch 0.18 of wlroots.
scdoc for manual pages. Cage is currently based on branch 0.18 of wlroots.
Simply execute the following steps to build Cage: