diff options
| author | Selene ToyKeeper | 2023-11-03 13:02:42 -0600 |
|---|---|---|
| committer | Selene ToyKeeper | 2023-11-03 13:02:42 -0600 |
| commit | a1bb12659b8c7950a76a542cdaa057d7a2cb2053 (patch) | |
| tree | 8fde70bf22be26ea249d0802517a645e1941c7c9 /make | |
| parent | added docs/which-hex-file.md to answer the #1 FAQ (diff) | |
| download | anduril-a1bb12659b8c7950a76a542cdaa057d7a2cb2053.tar.gz anduril-a1bb12659b8c7950a76a542cdaa057d7a2cb2053.tar.bz2 anduril-a1bb12659b8c7950a76a542cdaa057d7a2cb2053.zip | |
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
Diffstat (limited to '')
| -rwxr-xr-x | make | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -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 "$@" |
