nelstrom · April 2, 2024 20:18 · Apr 27, 2014 · Apr 23, 2014 · Apr 23, 2014 · Apr 23, 2014
diff --git a/plover-nkro-on-ergodox.md b/plover-nkro-on-ergodox.md
@@ -11,7 +11,7 @@ The NKRO firmware and Plover keymap can be found in the `simon_layout` branch of
     git clone [email protected]:shayneholmes/tmk_keyboard.git
     cd tmk_keyboard
     git fetch origin
-    git co -b simon_layout origin/simon_layout 
+    git checkout -b simon_layout origin/simon_layout 
 
 ## Build the firmware
 

diff --git a/plover-nkro-on-ergodox.md b/plover-nkro-on-ergodox.md
@@ -1,4 +1,4 @@
-[To run Plover you need an NKRO keyboard][nkro]. The [ErgoDox keyboard][ergodox] can be made to run in NKRO mode by following these steps.
+[Plover][] is an awesome open source stenography program, but to run the software [you need an NKRO keyboard][nkro]. The [ErgoDox keyboard][ergodox] can be made to run in NKRO mode by following these steps.
 
 ## Install dependencies
 
@@ -44,11 +44,15 @@ The Plover keymap looks like this:
 
 You can toggle the Plover layer on and off by pressing the `FN5` key ([here it is in code][code]). That's the left-thumb key above the "O" key in the diagram above.
 
+If any of these steps are unclear or incorrect, please feel free to fork+edit this gist. Thanks to Shayne Holmes for providing the Plover keymap and for answering my questions.
+-- Drew Neil
+
 [crosspack]: http://www.obdev.at/products/crosspack/download.html
 [assembly]: https://www.massdrop.com/ext/ergodox/assembly
 [test]: http://www.microsoft.com/appliedsciences/content/projects/KeyboardGhostingDemo.aspx
 [Plover keymap]: http://geekhack.org/index.php?action=dlattach;topic=53245.0;attach=51195;image
 [code]: https://github.com/shayneholmes/tmk_keyboard/blob/b76d9a33c02f500278eb5070b6d1a26439ce2fc1/keyboard/ergodox/keymap_plover.h#L9
 
 [nkro]: http://stenoknight.com/wiki/N-key_rollover
-[ergodox]: https://www.massdrop.com/buy/ergodox
+[ergodox]: https://www.massdrop.com/buy/ergodox
+[Plover]: https://github.com/openstenoproject/plover
diff --git a/plover-nkro-on-ergodox.md b/plover-nkro-on-ergodox.md
@@ -1,4 +1,4 @@
-[To run Plover you need an NKRO keyboard][]. The [ErgoDox keyboard][ergodox] can be made to run in NKRO mode by following these steps.
+[To run Plover you need an NKRO keyboard][nkro]. The [ErgoDox keyboard][ergodox] can be made to run in NKRO mode by following these steps.
 
 ## Install dependencies
 

diff --git a/plover-nkro-on-ergodox.md b/plover-nkro-on-ergodox.md
@@ -0,0 +1,54 @@
+[To run Plover you need an NKRO keyboard][]. The [ErgoDox keyboard][ergodox] can be made to run in NKRO mode by following these steps.
+
+## Install dependencies
+
+These instructions are based on [this document](https://github.com/shayneholmes/tmk_keyboard/blob/simon_layout/doc/build.md), which assumes you're using Windows. I'm using a mac, and I had to download and install the [CrossPack for AVR Development][crosspack] before the build process worked.
+
+## Download the source
+
+The NKRO firmware and Plover keymap can be found in the `simon_layout` branch of @shayneholmes fork of `tmk_keyboard`. Get the source:
+
+    git clone [email protected]:shayneholmes/tmk_keyboard.git
+    cd tmk_keyboard
+    git fetch origin
+    git co -b simon_layout origin/simon_layout 
+
+## Build the firmware
+
+    cd keyboard/ergodox
+    make -f Makefile.pjrc clean
+    make -f Makefile.pjrc plover
+
+The `keyboard/ergodox` directory should now contain `ergodox_pjrc.eep` and `ergodox_pjrc.hex` files.
+
+## Put the firmware on the Teensy chip
+
+The following steps are copied from steps 13-21 from the [ErgoDox assembly instructions][assembly]:
+
+1. Connect the ErgoDox keyboard to your computer via USB.
+1. Launch the Teensy loader app.
+1. Enable “Auto” mode in Teensy.app
+1. Drag the .eep file onto Teensy.app.
+1. Press the reset button on the Teensy chip. (You may see a dialogue box. That’s fine. After this step, “auto” mode will be disabled)
+1. Drag the .hex file onto Teensy.app
+1. Enable “Auto” mode in Teensy.app
+1. Press the reset button on the Teensy chip. (You’ll see “erasing” then “programming” progress bars, followed by “Reboot Ok”)
+
+## Toggle NKRO-mode and Plover layout
+
+NKRO is enabled by default. You can toggle the feature off and on by pressing *shift-shift-N* (i.e. press and hold the left and right shift keys, then press the N key). Use this [NKRO test widget][test] to confirm.
+
+The Plover keymap looks like this:
+
+![Plover keymap](http://geekhack.org/index.php?action=dlattach;topic=53245.0;attach=51195;image)
+
+You can toggle the Plover layer on and off by pressing the `FN5` key ([here it is in code][code]). That's the left-thumb key above the "O" key in the diagram above.
+
+[crosspack]: http://www.obdev.at/products/crosspack/download.html
+[assembly]: https://www.massdrop.com/ext/ergodox/assembly
+[test]: http://www.microsoft.com/appliedsciences/content/projects/KeyboardGhostingDemo.aspx
+[Plover keymap]: http://geekhack.org/index.php?action=dlattach;topic=53245.0;attach=51195;image
+[code]: https://github.com/shayneholmes/tmk_keyboard/blob/b76d9a33c02f500278eb5070b6d1a26439ce2fc1/keyboard/ergodox/keymap_plover.h#L9
+
+[nkro]: http://stenoknight.com/wiki/N-key_rollover
+[ergodox]: https://www.massdrop.com/buy/ergodox