Add BUILD instructions, update README and revise TODO

[uccvend-snackrom.git] / BUILD

diff --git a/BUILD b/BUILD
new file mode 100644 (file)
index 0000000..d3dfdd5
--- /dev/null
+++ b/BUILD
@@ -0,0 +1,55 @@
+Build Instructions for UCC Vend Snack ROM
+-----------------------------------------
+
+Code for the Snack Rom is located in ROM2
+
+To build, require:
+       perl
+       make
+       binutils-m68hc1x
+        gcc-m68hc1x
+
+INSTRUCTIONS
+------------
+
+cd ROM2
+
+# clean out old objects
+
+make clean
+
+# do your changes
+
+make
+
+# adjust src2asm.pl if required
+# trim code as necessary due to ROM being very full if size is greater than remaining space to
+# keep copy of code in the ROM
+
+# all good
+
+make clean
+
+# commit your changes, etc, etc - git commit
+
+git commit -a
+
+# tag the ROM revision
+# ROM tag convention is ROMY, ROMZ, ROM2A, ROM2B, ROM2C, ...
+
+git tag -a ROMY
+
+# push your code and tag upstream
+
+git push --tags
+
+# build it
+# git tag is used in ROM build ID shown with ABOUT and IDENTIFY commands
+# output of:   git describe --long
+
+make
+
+# rom2.b is the ROM image to be burnt
+
+# send email to [email protected] and let them know of your success
+