brl/citadel
1
0
Fork 2
Code Issues Pull Requests 2 Packages Projects Releases Wiki Activity
835d40b176
citadel/docs
History
David McKinney 9cda830f1f Update base realmfs from buster to bullseye 
- Base realmfs is now based on Debian bullseye
- Replaced buster link in docs/duck/realmfs.duck with bullseye
- Added neovim as the default vim in the base realmfs packages
2021-03-20 20:27:15 -04:00
..
duck Update base realmfs from buster to bullseye 2021-03-20 20:27:15 -04:00
.gitignore Citadel documentation system 2020-12-07 17:24:22 -05:00
Makefile Citadel documentation system 2020-12-07 17:24:22 -05:00
README.md Citadel documentation system 2020-12-07 17:24:22 -05:00

README.md

Writing documentation

http://projectmallard.org/ducktype/1.0/index.html

Building documentation

Building the documentation requires the 'ducktype' utility. The makefile will use this command to generate a directory of .page files from the .duck files in the /duck directory.

$ sudo apt install ducktype
$ make

Reading documentation

After generating the documentation it can be previewed by running yelp on the /pages directory:

$ yelp pages

Installing documentation

After making changes to the documentation, run 'make install' to update the set of .page files in the citadel-documentation recipe.

$ make install