From: Mark Tearle <mark@tearle.com>
Date: Thu, 26 Mar 2015 15:29:27 +0000 (+0800)
Subject: Add BUILD instructions, update README and revise TODO
X-Git-Url: https://git.ucc.asn.au/?a=commitdiff_plain;h=874d640934e5e3c6fedca8abdbe6e828c537db28;p=uccvend-snackrom.git

Add BUILD instructions, update README and revise TODO
---

diff --git a/BUILD b/BUILD
new file mode 100644
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 tech@ucc.gu.uwa.edu.au and let them know of your success
+
diff --git a/README b/README
index b1ae323..ebe63f1 100644
--- a/README
+++ b/README
@@ -16,7 +16,10 @@ This repository holds the C code for the new ROM for the UCC Snack Machine.
 
 FILES
 -----
-
+ README
+	This file
+ BUILD 
+	Instructions on how to build the new ROM and tag revisions
  original/....
 	Original Snack Machine ROM and disassemblies
  original/ROM-2003/....
diff --git a/TODO b/TODO
index 02f47f0..54d8de2 100644
--- a/TODO
+++ b/TODO
@@ -6,46 +6,22 @@ TODO list for UCC Vend Snack ROM
 Starting point keypad.c - keypad_read() Line 52
 
 
-2/ Split VERSION information out into seperate file
 
-Create version.h or similar
-Version should be made of three parts
 
-ALPHA-STRING [A-Z]*
-GIT-TAG string
-DATE	ISO8601 format, no dashes eg 20040625
+2/ DONE - Split VERSION information out into seperate file
 
-Example:
-	ROM ROMX 20040625
+Script to generate from Makefile.  Final testing needed
 
-For virtual machines, alpha part shall be VIRTUAL
-For real machines, alpha part shall be ROM
+3/ DONE - Add VERSION command to output version number of ROM
 
-Modify main_basic.c as appropriate
+Is IDENTIFY command.  Final build to be tested.
 
-Partially done.
-
-git tag -a ROMY
-git push --tags
-
-git describe --long
-
-
-3/ Add VERSION command to output version number of ROM
-
-
-Send:
-
-VERSION
-
-Receive:
-
-086 X 20040625
-
-4/ Fix periods on VFD display
+4/ DONE - Fix periods on VFD display
 
 Existing bug with the VFD display on the Snack Machine
 
 For example, to display "WORD." needs to be transmitted to the machine
 as "WOR.D"
 
+Final build to be tested on hardware.
+