aboutsummaryrefslogtreecommitdiff
path: root/docs/tools.md
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2021-06-08 19:54:22 +0100
committerJuan J. Martinez <jjm@usebox.net>2021-06-08 19:54:49 +0100
commitae19de1c2dcc160495fcffb198f9266cd52a36a5 (patch)
treed19e2adc73399c3840c320a4993bd39ffa68e8ca /docs/tools.md
parentca9f36b82d7987546efd60acfaac22e3fd834f16 (diff)
downloadubox-msx-lib-ae19de1c2dcc160495fcffb198f9266cd52a36a5.tar.gz
ubox-msx-lib-ae19de1c2dcc160495fcffb198f9266cd52a36a5.zip
Tools doc placeholder
Diffstat (limited to 'docs/tools.md')
-rw-r--r--docs/tools.md32
1 files changed, 32 insertions, 0 deletions
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
+