~grtcdr/citron

bf1dc817dba3dfe942197196c9e2a286d861bfff — grtcdr 1 year, 1 month ago 8742fd8
Add configuration steps to README
1 files changed, 17 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +17 -1
@@ 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