docs: add rules to make .html files
commit381e1230d6614ea6267080404ce25f65e06c1ef3
authorKyle J. McKay <mackyle@gmail.com>
Tue, 13 Feb 2018 22:45:17 +0000 (13 14:45 -0800)
committerKyle J. McKay <mackyle@gmail.com>
Tue, 13 Feb 2018 22:45:17 +0000 (13 14:45 -0800)
tree531b5927795c808e2940b2524c32c0561134df4a
parenta310b6fa2df47b03f2cb227c74d3c3211f83c51b
docs: add rules to make .html files

The documentation files are written in GFM (Girocco Flavored Markdown)
for which we conveniently have a formatter located in the markdown.git
submodule.

Add a suitable POSIX-compatible Makefile in the docs subdirectory
that knows how to process all *.txt files into *.html files using
the Markdown.pl script from the markdown.git submodule.

Add a "doc" rule to the top-level makefile to facilitate building
these "docs" and at the same time enhance the top-level "clean"
rule to actually do a clean.

The only things required to build the "docs" are:

 1) "perL" 5.8 or later is available in the $PATH somewhere
 2) the "markdown.git" submodule has been inited (i.e. checked out)
 3) a POSIX-compatible make is available

No other submodules need be checked out nor is a "special" version
of make required.

Just running:

    (cd docs && make)

will build the .html versions of all the docs provided the above
conditions have been met.

Signed-off-by: Kyle J. McKay <mackyle@gmail.com>
GNUmakefile
docs/.gitignore [new file with mode: 0644]
docs/Makefile [new file with mode: 0644]
docs/technical/gc-mini.txt
docs/technical/gc.txt