From 7f9e2364e3837853fae798abec90b21023351d39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Vani=C5=A1?= Date: Mon, 28 Oct 2024 10:24:16 +0100 Subject: [PATCH 1/2] readme: Link man pages --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec6ce789..13c0508a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,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. Cage is currently based on branch 0.18 of wlroots. +scdoc for manual pages (or see them [here](./cage.1.scd)). Cage is currently based on branch 0.18 of wlroots. Simply execute the following steps to build Cage: From 57c99771443a859a5f8c19949e647fdd3948b065 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michal=20Vani=C5=A1?= Date: Sat, 2 Nov 2024 17:13:20 +0100 Subject: [PATCH 2/2] readme: Include man page reference for command-line options and env vars --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 13c0508a..d2852191 100644 --- a/README.md +++ b/README.md @@ -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: