From ae19de1c2dcc160495fcffb198f9266cd52a36a5 Mon Sep 17 00:00:00 2001
From: "Juan J. Martinez" <jjm@usebox.net>
Date: Tue, 8 Jun 2021 19:54:22 +0100
Subject: Tools doc placeholder

---
 docs/Makefile    |  6 +++++-
 docs/header.html |  1 +
 docs/tools.md    | 32 ++++++++++++++++++++++++++++++++
 3 files changed, 38 insertions(+), 1 deletion(-)
 create mode 100644 docs/tools.md

diff --git a/docs/Makefile b/docs/Makefile
index 9a928f8..41c9732 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,4 +1,4 @@
-all: ubox-lib-ref.html spman-lib-ref.html mplayer-lib-ref.html extra-lib-ref.html
+all: ubox-lib-ref.html spman-lib-ref.html mplayer-lib-ref.html extra-lib-ref.html tools-ref.html
 
 ubox-lib-ref.html: ../include/ubox.h ../tools/hdoc.py footer.md header.html
 	../tools/hdoc.py --footer footer.md "ubox.lib reference" < ../include/ubox.h > reference.ubox.md
@@ -16,6 +16,10 @@ extra-lib-ref.html: ../include/ap.h ../tools/hdoc.py footer.md extra.md header.h
 	../tools/hdoc.py --header extra.md --footer footer.md "extra libs reference" < ../include/ap.h > reference.extra.md
 	pandoc -s -t html5 -c water.css -c monokai.css --toc --no-highlight -F ../tools/pandocfilter-pygments.py -B header.html reference.extra.md -o $@
 
+tools-ref.html: ../tools/hdoc.py footer.md tools.md header.html
+	../tools/hdoc.py --header tools.md --footer footer.md "tools reference" < /dev/null > reference.tools.md
+	pandoc -s -t html5 -c water.css -c monokai.css --toc --no-highlight -F ../tools/pandocfilter-pygments.py -B header.html reference.tools.md -o $@
+
 clean:
 	rm -f *-lib-ref.html reference.*.md
 
diff --git a/docs/header.html b/docs/header.html
index fbc15df..20027fd 100644
--- a/docs/header.html
+++ b/docs/header.html
@@ -4,4 +4,5 @@
     <a href="spman-lib-ref.html">spman.lib reference</a>
     <a href="mplayer-lib-ref.html">mplayer.lib reference</a>
     <a href="extra-lib-ref.html">extra libs reference</a>
+    <a href="tools-ref.html">tools reference</a>
 </nav>
diff --git a/docs/tools.md b/docs/tools.md
new file mode 100644
index 0000000..ee42261
--- /dev/null
+++ b/docs/tools.md
@@ -0,0 +1,32 @@
+## Overview
+
+These are some tools written in Python that are required to build the example
+game and can be used in new projects.
+
+This reference should complement both the command line help available in all
+tools (with `-h` flag), and the example game itself.
+
+## Data conversion tools
+
+### png2tiles.py
+
+TODO
+
+### png2sprites.py
+
+TODO
+
+### map.py
+
+TODO
+
+## Build helpers
+
+### chksize
+
+TODO
+
+### mkdeps.py
+
+TODO
+
-- 
cgit v1.2.3