From edf873de1258ab6f8143a92bf2c85a412df8b39e Mon Sep 17 00:00:00 2001
From: n loewen <nick@nloewen.com>
Date: Wed, 2 Aug 2023 12:08:32 +0100
Subject: [PATCH] Add info on how to run the assembler/simulator

---
 readme.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index 9508079..2fbfa98 100644
--- a/readme.md
+++ b/readme.md
@@ -2,8 +2,6 @@
 
 ## TODO
 
-- [ ] Document current state of affairs (how to run it etc)
-
 Computer:
 - [ ] Implement carry flag on SUB
 
@@ -13,6 +11,17 @@ Misc:
 - [ ] Do a proper binary version... (or lose the typed arrays?)
 - [ ] Extract debugging to its own module
 
+## Run the assembler/simulator
+
+Assemble source code:  
+```npm run assemble source_code.asm```
+
+Assemble and run, with animated display of screen memory:  
+```npm run display source_code.asm```
+
+Assemble and run, with debug output:  
+```npm run debug source_code.asm```
+
 ## Instruction set
 
     0   END