From b295d8c83e39a0397465bd06596d223c97a93704 Mon Sep 17 00:00:00 2001
From: Astrid Smith
Date: Thu, 20 Oct 2011 22:31:03 -0700
Subject: Documentation

---
 README.markdown | 13 +++++++++----
 main.asm        | 32 ++++++++++++++++----------------
 opcodes.asm.m4  |  6 ++++++
 3 files changed, 31 insertions(+), 20 deletions(-)

diff --git a/README.markdown b/README.markdown
index 7f1c6b5..9e120d2 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,8 +1,13 @@
 z680k: z80 emulator for 68k calculators
 =======================================
-
-Astrid Smith  
-Project started: 2010-06-06  
+      666   888   000  k  k
+zzzz 6     8   8 0   0 k k
+  z  6666   888  0 0 0 kk
+ z   6   6 8   8 0   0 k k
+zzzz  666   888   000  k  k
+
+Astrid Smith
+Project started: 2010-06-06
 GPL
 
 The intent of this project is to provide a fast and correct TI-83+
@@ -73,4 +78,4 @@ Incompatibilities with Real Hardware
    may not work.  This is apparently a rare enough occurence that
    ignoring it is reasonable.
 
-2. 
+2.
diff --git a/main.asm b/main.asm
index 7e74f7b..cde9e89 100644
--- a/main.asm
+++ b/main.asm
@@ -10,29 +10,29 @@
 
 ;;; Registers used:
 ;;;
-;;; A7 = sp
-;;; A6 = emulated PC XXX
-;;; A5 = instruction table base pointer
-;;; A4 = emulated SP XXX
-;;; A3 = pointer to flag_storage
-;;; A2 =
-;;; A1 =
-;;; A0 =
+;;; A7		68000 stack pointer
+;;; A6/epc	emulated PC
+;;; A5		instruction table base pointer
+;;; A4		emulated SP
+;;; A3		pointer to flag_storage
+;;; A2		
+;;; A1		
+;;; A0		
 ;;;
-;;; D0 = current instruction, scratch for macros
-;;; D1 = scratch for instructions
-;;; D2 = further scratch
+;;; D0		current instruction, scratch for macros
+;;; D1		scratch for instructions
+;;; D2		further scratch
 ;;;
 ;;;
 ;;; The following have their shadows in the top half of the register
-;;; D3 = AF	A is in the low byte, F in the high byte (yeah ... speed)
-;;; D4 = BC	B high, C low
-;;; D5 = DE	D high, E low
-;;; D6 = HL	H high, L low
+;;; D3/eaf = AF		A is in the low byte, F in the high byte (yeah ... speed)
+;;; D4/ebc = BC		B high, C low
+;;; D5/ede = DE		D high, E low
+;;; D6/ehl = HL		H high, L low
 ;;;
 ;;; IY is used more often so it's easier to get at.  It can be slow
 ;;; but I don't really care to go to the effort to make it so.
-;;; D7 = IX (hi), IY (low)
+;;; D7/eixy = IX (hi word), IY (low word)
 
 
 ;;; emulated I and R are both in RAM
diff --git a/opcodes.asm.m4 b/opcodes.asm.m4
index 99ead9d..03fd7cd 100644
--- a/opcodes.asm.m4
+++ b/opcodes.asm.m4
@@ -222,6 +222,12 @@ TIME	MACRO
 
 emu_plain_op:			; Size(bytes) Time(cycles)
 				; S0 T0
+
+	;; I would like to thank the State of Washington for
+	;; supporting the initial development of this file, by giving
+	;; me a job doing nothing with no oversight for hours at a
+	;; time.
+
 	;; NOP
 OPCODE(00,«»,4)
 
-- 
cgit v1.2.3