From a1bb12659b8c7950a76a542cdaa057d7a2cb2053 Mon Sep 17 00:00:00 2001 From: Selene ToyKeeper Date: Fri, 3 Nov 2023 13:02:42 -0600 Subject: documentation updates... - fleshed out main README.md a bit - improved github formatting for docs/which-hex-file.md - added 'make docs' to preview .md files as .html - ignore html files generated by 'make docs' - removed rampingios-v3.html file generated years ago --- make | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'make') diff --git a/make b/make index 2221ffe..40fc398 100755 --- a/make +++ b/make @@ -26,6 +26,7 @@ Usage: ./make TASK todo Show tasks noted in source code files models Generate the MODELS file release Zip up all .hex files to prep for publishing a release + docs Convert all .md files to .html ... or TASK can be the partial name of a build target. @@ -55,6 +56,9 @@ function main() { echo 'rm -vf **/*.hex **/*~ **/*.elf **/*.o **/*.cpp' rm -vf **/*.hex **/*~ **/*.elf **/*.o **/*.cpp ;; + docs) + make-docs + ;; flash) echo "Not implemented yet." #./bin/flash.sh "$@" @@ -75,5 +79,13 @@ function main() { esac } +function make-docs () { + for md in **/*.md ; do + echo "$md" + html=$(echo "$md" | sed 's/.md$/.html/') + cmark-gfm "$md" > "$html" + done +} + main "$@" -- cgit v1.2.3