Initial files

README.md

@@ -1,3 +1,39 @@
-# msxbuild
+# MSXBUILD
+
+Utils to use openMSX in build pipelines.
+
+You can use these scripts as-is. But as always, feel free to extend it
+for your specific needs or contribute a fix or feature.
+
+## Makefile features
+
+* SDCC msx build steps
+* Headless openMSX buildpipe on max speed.
+* openMSX safe exit failure guards.
+* Automatic disk image import + export per build step.
+* wgets resources from msxhub
+
+## TCL Scripts
+
+Tcl scripts for safe openMSX integrations as reliable build step
+in compiling/packing/testing msx software natively.
+But managed from external build tool like make or scripts.
+This means that great care is given to make sure that openMSX
+exits correctly.
+
+The use this, pass the one or more scripts on the command line and
+set the optional environment variables when executing openMSX:
+
+    FAIL_AFTER_BOOT=30 \
+    FAIL_AFTER_PATH=bin/myapp \
+    BOOT_HDD_PATH=bin/myapp/disk \
+    BOOT_HDD_IMAGE=bin/myapp/disk.img \
+    JOYPORTA=mouse \
+    openmsx \
+      -script <path-to>/boot_env.tcl \
+      -script <path-to>/boot_hdd.tcl \
+      -script <path-to>/fail_after.tcl \
+      -machine ...
+
+Check the scripts source code for more (technical) details.
 
-Utils to use openMSX in build pipelines.