From c4f9bd46b1a64206b2e6e158a9f5e50b2689c443 Mon Sep 17 00:00:00 2001 From: Josh Taylor Date: Sun, 2 Apr 2023 16:36:29 +0800 Subject: [PATCH] Add notes about running the documentation site --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b51def..88e1086 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,25 @@ [labwc.github.io](https://labwc.github.io) -Edit `src/*.md` -Run `./build-site` +## Contributing +1. Edit `src/*.md` +2. Run `./build-site` +## Requirements +To build the documentation site, you will need the following software installed: +- [pandoc](https://pandoc.org/getting-started.html) +- [scdoc](https://git.sr.ht/~sircmpwn/scdoc) + +### ArchLinux +`pacman -Syu pandoc-cli scdoc` + +### Ubuntu / Debian +`apt install pandoc scdoc` + +### Fedora +`dnf install pandoc scdoc` + +### Other Linuxes +For Pandoc, see the [pandoc installation](https://pandoc.org/installing.html#linux) documentation about the inclusion of pandoc in your package manager. + +For scdoc, this should also be in your package manager. \ No newline at end of file