Skip to content

Add notes about running the documentation site #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add notes about running the documentation site #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.