diff --git a/README.md b/README.md index e69de29..da8894e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +This is a BSD Makefile base webpage generator. + +Pretty minimal... no features at all. + +It needs: + +- BSD make (written and tested on OpenBSD) +- discount (for parsing markdown file) +- asciidoctor + asciidoctor-diagram extension (for parsing asciidoctor files) +- ksh (for shell stuff) +- rsync (to copy static files) + +Basic operation: + +src/header.th gets prepended to every file. +src/footer.th gets appended to every file. + +.pa files contain asciidoctor source. +.pm files contain markdown source. +.ph files contain plain html. +.ps files contain ksh shell script (the scripts must output html to stdout). + +Everything in src/assets is copied as is