From fa3ecc00731d3f6045ba2c18aced28cb988d6fa9 Mon Sep 17 00:00:00 2001
From: Aryadev Chavali <aryadev@aryadevchavali.com>
Date: Wed, 29 Nov 2023 17:00:39 +0000
Subject: Easier to read documentation in examples

---
 examples/factorial.asm | 15 +++++++++------
 examples/fib.asm       | 15 +++++++++------
 2 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/examples/factorial.asm b/examples/factorial.asm
index 021360b..42c0785 100644
--- a/examples/factorial.asm
+++ b/examples/factorial.asm
@@ -1,19 +1,20 @@
 ;;; factorial.asm: A program that generates the factorials of each
-;;;  number from 1 to 24 (24!~=UINT64_MAX).  Using the registers to
+;;;  number from 1 to 22 (22!~=UINT64_MAX).  Using the registers to
 ;;;  store `n` and `n!`.
+
   ;; Constants
   %const(limit) 22 %end
 
   ;; Setup entrypoint
   global main
 main:
-  ;; Setup initial REG[0] = 1 and REG[1] = 1
+  ;; $I -> W[0] = 1, $J -> W[1] = 1
   push.word 1
   mov.word 0
   push.word 1
   mov.word 1
 
-  ;; Print `REG[0]: REG[1]`
+  ;; Print `$I: $J`
 loopback:
   push.byte '\t'
   print.char
@@ -28,21 +29,23 @@ loopback:
   push.byte '\n'
   print.char
 
-  ;;  REG[0] += 1
+  ;;  $I += 1
   push.reg.word 0
   push.word 1
   plus.word
   mov.word 0
 
-  ;;  REG[1] *= REG[0]
+  ;;  $J *= $I
   push.reg.word 0
   push.reg.word 1
   mult.word
   mov.word 1
 
+  ;; IF $I >= $LIMIT ...
   push.word $limit
   push.reg.word 0
   gte.word
-  ;; Jump to `loopback`
+  ;; THEN jump to `loopback`
   jump.if.byte loopback
+  ;; ELSE halt
   halt
diff --git a/examples/fib.asm b/examples/fib.asm
index 717ca8c..565c5a8 100644
--- a/examples/fib.asm
+++ b/examples/fib.asm
@@ -6,6 +6,7 @@
 
   ;; Constants
   %const(limit) 12200160415121876738 %end
+
   %const(increment_i)
   push.reg.word 2
   push.word 1
@@ -31,36 +32,38 @@
   ;; Setup entrypoint
   global main
 main:
-  ;; Setup iterator i
+  ;; Setup iterator I
   push.word 1
   mov.word 2
-  ;; Setup initial REG[0] = 1 and REG[1] = 1
+  ;; Setup initial A -> W[0] = 1 and B -> W[1] = 1
   push.word 1
   mov.word 0
   push.word 1
   mov.word 1
 
-  ;; Print REG[0] and REG[1]
+  ;; Print "$I: $A" and "($I + 1): $B"
 loopback:
   call print_pair
 
-  ;;  REG[0] += REG[1]
+  ;;  $A += $B
   push.reg.word 0
   push.reg.word 1
   plus.word
   mov.word 0
 
-  ;;  REG[1] += REG[0]
+  ;;  $B += $A
   push.reg.word 0
   push.reg.word 1
   plus.word
   mov.word 1
 
+  ;; IF $B >= $LIMIT ...
   push.word $limit
   push.reg.word 1
   gte.word
-  ;; Jump to `loopback`
+  ;; THEN jump to `loopback`
   jump.if.byte loopback
+  ;; ELSE halt
   halt
 
 print_pair:
-- 
cgit v1.2.3-13-gbd6f