summaryrefslogtreecommitdiff
path: root/DEVELOPERS.md
diff options
context:
space:
mode:
authorGravatar Mike Burns <mike@mike-burns.com>2013-07-30 22:39:50 -0400
committerGravatar Mike Burns <mike@mike-burns.com>2013-07-30 22:39:50 -0400
commitb0ce91a8f871dd78831ddc2beec24f19327533d7 (patch)
tree1935b44445c9729df5952c8d701a3b63c1f13255 /DEVELOPERS.md
parentc44ac8476d92058779b608ac9592a208247d2de3 (diff)
Document how to generate the gh-pages
The mdocml tools, specifically mandoc(1), are used to generate the gh-pages HTML docs. This documentation is now documented.
Diffstat (limited to 'DEVELOPERS.md')
-rw-r--r--DEVELOPERS.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/DEVELOPERS.md b/DEVELOPERS.md
index 55dad80..3ff3516 100644
--- a/DEVELOPERS.md
+++ b/DEVELOPERS.md
@@ -24,7 +24,22 @@ First, everything must be set up just right:
rm -f rcm-0.0.2/tags && \
tar --exclude=*swp --exclude-backups --exclude-vcs --exclude=debian -zcf rcm_0.0.2.orig.tar.gz rcm-0.0.2
-Given that, now you can generate the Debian package:
+Given that, now you can generate the Debian package. This requires the
+Debian packaging tools, especially debuild:
cd ~/debian/rcm/rcm-0.0.2 && \
debuild -us -uc
+
+HTML documentation
+------------------
+
+The HTML documentation can be generated using the mdocml suite,
+especially mandoc(1). This shell command will generate them all into a
+separate `rcm-gh-pages` directory:
+
+ for i in lsrc.1 mkrc.1 rcm.7 rcrc.5 rcup.1; do
+ mandoc -Thtml -Oman=%N.%S.html man/$i > ~/rcm-gh-pages/$i.html
+ done
+ cp ~/rcm-gh-pages/rcm.7.html ~/rcm-gh-pages/index.html
+
+More information on mdocml can be found on http://mdocml.bsd.lv/ .