repo cleanup

barrettotte · Sep 6, 2021 · 7ff17db · 7ff17db
1 parent 1567971
commit 7ff17db
Show file tree

Hide file tree

Showing 16 changed files with 29 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -1,37 +1,35 @@
 # qr-asm
 
-Generate a QR code image from scratch with only ARM assembly.
+Generate a QR code from scratch with only ARM assembly.
 
 This was made just to learn how QR codes work and to learn ARM assembly with a really challenging project.
 
-## Disclaimer
+<figure>
+  <img src="./docs/asm_qrcode.png" alt="QR code to my GitHub profile."/>
+  <figcaption>
+    A byte mode QR code of 
+    <a href="https://github.com/barrettotte">https://github.com/barrettotte</a> using Q error correction level.
+  </figcaption>
+</figure>
 
-The biggest thing is that **this hasn't been fully tested**. I got my one scenario working and that's good enough
-for me. I'd test some others, but I'm not looking for trouble.
+## Usage
+
+`Usage: qrcode msg err_lvl`
 
-If its not obvious I'm bad at assembly...I'm sure there are a disgusting amount of optimizations I could have done. 
-But, I tried to keep things simple so a dummy like me could understand this a year from now.
-Specifically, I didn't really leverage 32-bit word sizes or ARM's fancy optional shifting on each instruction.
+valid error levels: `L=1, M=0, Q=3, H=2`
 
-Additionally, the binary generated is massive...I haven't messed with linkers yet. 
-So I'm just going to leave it the way it is for now...
+My primary test - `./bin/qrcode "https://github.com/barrettotte" 3`
 
-## QR Code Limitations
+Quick build and test - `make && make test`
+
+## Limitations
 
 I constrained the QR code generation a lot. I just wanted to encode a url, not build a whole library.
 
 - Byte mode encoding only
 - QR version 4 and below (up to 80 characters with v4-L)
 - Mask evaluation not implemented, hardcoded to mask 0 (I think masks only effect scan efficiency)
-
-## Usage
-
-`Usage: qrcode msg err_lvl`
-
-My primary test - `./bin/qrcode "https://github.com/barrettotte" 3`
-
-error levels: `L=1, M=0, Q=3, H=2`
-
+- Instead of implementing an entire image file spec, I used [PBM](https://en.wikipedia.org/wiki/Netpbm) files to create my QR code image.
 
 ### Debugging with GDB
 
@@ -52,4 +50,4 @@ For sanity checking this ugly thing, see my notes in [docs/3Q-test.md](docs/3Q-t
 - [Reed Solomon Codes for Coders](https://en.wikiversity.org/wiki/Reed%E2%80%93Solomon_codes_for_coders)
 - [GDB Command Reference](https://visualgdb.com/gdbreference/commands/x)
 - [PBM File Description](https://oceancolor.gsfc.nasa.gov/staff/norman/seawifs_image_cookbook/faux_shuttle/pbm.html)
-- [Netpbm Wiki](https://en.wikipedia.org/wiki/Netpbm)
+- [Netpbm Wiki](https://en.wikipedia.org/wiki/Netpbm)
diff --git a/jupyter/lunch-and-learn.ipynb → docs/jupyter/lunch-and-learn.ipynb b/jupyter/lunch-and-learn.ipynb → docs/jupyter/lunch-and-learn.ipynb
diff --git a/jupyter/mask-0.png → docs/jupyter/mask-0.png b/jupyter/mask-0.png → docs/jupyter/mask-0.png
diff --git a/jupyter/mask-1.png → docs/jupyter/mask-1.png b/jupyter/mask-1.png → docs/jupyter/mask-1.png
diff --git a/jupyter/mask-2.png → docs/jupyter/mask-2.png b/jupyter/mask-2.png → docs/jupyter/mask-2.png
diff --git a/jupyter/mask-3.png → docs/jupyter/mask-3.png b/jupyter/mask-3.png → docs/jupyter/mask-3.png
diff --git a/jupyter/mask-4.png → docs/jupyter/mask-4.png b/jupyter/mask-4.png → docs/jupyter/mask-4.png
diff --git a/jupyter/mask-5.png → docs/jupyter/mask-5.png b/jupyter/mask-5.png → docs/jupyter/mask-5.png
diff --git a/jupyter/mask-6.png → docs/jupyter/mask-6.png b/jupyter/mask-6.png → docs/jupyter/mask-6.png
diff --git a/jupyter/mask-7.png → docs/jupyter/mask-7.png b/jupyter/mask-7.png → docs/jupyter/mask-7.png
diff --git a/jupyter/qrcode.png → docs/jupyter/qrcode.png b/jupyter/qrcode.png → docs/jupyter/qrcode.png
diff --git a/python/.flake8 → docs/python/.flake8 b/python/.flake8 → docs/python/.flake8
diff --git a/python/galois.py → docs/python/galois.py b/python/galois.py → docs/python/galois.py
diff --git a/python/qrcode.png → docs/python/qrcode.png b/python/qrcode.png → docs/python/qrcode.png
diff --git a/python/qrcode.py → docs/python/qrcode.py b/python/qrcode.py → docs/python/qrcode.py
diff --git a/reed-solomon.s b/reed-solomon.s
@@ -3,18 +3,17 @@
             // exports
             .global reed_solomon  // Reed-Solomon error correction
 
-            // internal:
-            //
-            // new_msg_poly - build polynomial from message
-            // new_gen_poly - build generator polynomial
-            // gf256_mul    - multiplication in Galois Field 2^8
-            // gf256_inv    - inversion in Galois Field 2^8
-            // gf256_div    - division in Galoi field 2^8
-            // poly_clr     - reset a polynomial's data
-            // poly_norm    - polynomial normalization
-            // poly_add     - polynomial addition
-            // poly_mul     - polynomial multiplication
-            // poly_rem     - find remainder of polynomial long division
+            // internal subroutines
+            //   new_msg_poly - build polynomial from message
+            //   new_gen_poly - build generator polynomial
+            //   gf256_mul    - multiplication in Galois Field 2^8
+            //   gf256_inv    - inversion in Galois Field 2^8
+            //   gf256_div    - division in Galoi field 2^8
+            //   poly_clr     - reset a polynomial's data
+            //   poly_norm    - polynomial normalization
+            //   poly_add     - polynomial addition
+            //   poly_mul     - polynomial multiplication
+            //   poly_rem     - find remainder of polynomial long division
 
             // constants
             .equ  POLY_SIZE, 128  // max terms in a polynomial