From bf1dc817dba3dfe942197196c9e2a286d861bfff Mon Sep 17 00:00:00 2001 From: grtcdr Date: Wed, 2 Aug 2023 17:06:08 +0100 Subject: [PATCH] Add configuration steps to README --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c1d68d..0876544 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,23 @@ bindsym { # Configuration -See the [configuration wiki page](https://man.sr.ht/~grtcdr/citron/configure.md). +This topic is fully documented in `citron(1)`. If you've installed +citron through a package manager (with the exception of cargo), then +you may be able to view the manpage directly from your terminal by +issuing `man citron`. + +If you don't have access to the manpages, you will wnat to build them. +To do this, you should first install `scdoc`, clone the repository and +then run the following in a shell: + +``` +# Navigate to where the manpage is located +cd citron/doc +# Build the manpage +scdoc < citron.1.scd > citron.1 +``` + +You can now view the manpage by running `man -l citron.1`. # Acknowledgements -- 2.45.2