From b417322c4f6fb5b8f8fa26a53b2489bfed9ef84f Mon Sep 17 00:00:00 2001
From: Bruce Barnett <github@grymoire.com>
Date: Sun, 10 Jul 2022 11:12:49 -0400
Subject: [PATCH] improved table

---
 LINUX.md | 43 ++++++++++++++++++++++---------------------
 1 file changed, 22 insertions(+), 21 deletions(-)

diff --git a/LINUX.md b/LINUX.md
index c99632a..042bfa1 100644
--- a/LINUX.md
+++ b/LINUX.md
@@ -6,30 +6,31 @@ which made it difficult to use on Linux systems
 
 This version of the firmware has been modified to support Linux systems.
 The following changes have been made
-    1) The backspace key works during the GUI login
-    2) The Sym key not acts as a Control key, so SYM+C is Control-C
-    3) The four top button keys are now used to provide the missing characters.
+- The backspace key works during the GUI login
+- The Sym key not acts as a Control key, so SYM+C is Control-C
+- The four top button keys are now used to provide the missing characters.
 
 The original definiton of the keys were this 
 
-	    L1	    L2		R1		R2		SPKR	Mic BS  NL  SPACE
-		                            	$		~   \b  \n
-Shift  
-Alt	                                            0
-Sym		                                                |	TAB
+|      | L1    | L2    |    R1 |    R2 | SPKR | Mic| BS| NL|  SPACE  |
+| ------|-------|-------|-------|-------|------|----|---|---|---------|
+| <none>|       |       |       |       |  $   |  ~ | \b| \n| <space> |
+| Alt   |       |       |       |       |  `   |  0 |   |   |         |
+| Shift |       |       |       |       |  $   |    |   |   |         |
+| Sym   |       |       |       |       |  $   |    |   |\| |  <tab>  |
 
 
 
-The current definition of the keys are
+This firmware adds the following mappings
 
-        L1      L2      R1      R2      SPKR    Mic BS  NL  Spacebar
-<none>  <esc>   %       =       \       $       ~   BS  \n  <space>
-Alt     >       ]       }       &       `       ~   x       <tab>
-Shift   <       [       {       ^       $       `   BS      <space>
-Sym     x       x       x       x       $       ~   BS  |   <space>
+|      | L1     | L2    |    R1 |    R2 | SPKR | Mic| BS| NL|  SPACE  |
+| ------|--------|-------|-------|-------|------|----|---|---|---------|
+| <none>|<escape>|  %    |  =    |  \\   |  $   |  ~ | \b| \n| <space> |
+| Alt   |  >     |  ]    |  }    |  &    |  `   |  0 |   |   |         |
+| Shift |  <     |  ]    |  {    |  ^    |  $   |  ~ | \b|   |         |
+| Sym   |        |       |       |       |  $   |  ~ | \b|\| |  <tab>  |
 
-
-#Linux Debug tips
+## Linux Debug tips
 
 The keyboard was two "outputs" - one is the USB HID interface, the other is the serial port.
 Any printf() command goes to the serial port.
@@ -39,19 +40,19 @@ to learn the name, as the newest port will appear first. On my system, it's /dev
 
 So on one terminal, I type
 
-cat -v </dev/ttyACM0
+    cat -v </dev/ttyACM0
 
 while on a second terminal window, I type
 
-cat -v
+    cat -v
 
 The first one will print all of the printf output, and the second will show you how the keyboard works normally.
 
-#Compiling on Linux
+## Compiling firmware on Linux
 
 I edit the files in <GIT>/ic2_puppet/all/ using my preferred editor. In my case, I use emacs. I have the keystroke combination "Control-C M" bound to compile, using 
 
-(global-set-key "\C-cm" 'compile)
+    (global-set-key "\C-cm" 'compile)
 
 And when I press these keys, emacs saves all files, and recompiles the
 code. I have a small hub with switchable on/off ports, and restart the
@@ -59,7 +60,7 @@ keyboard into boot mode, and then do a "make install" to load the new
 firmware
 
 
-#TODO
+## TODO
 
 Currently - the SYM+Button keys are defined as the character "x" to indicate it's not been specified.
 I'l like to make these keys to the 4 arrow keys.