summaryrefslogtreecommitdiff
path: root/keyboards/ergodox_ez/keymaps/supercoder/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ergodox_ez/keymaps/supercoder/README.md')
-rw-r--r--keyboards/ergodox_ez/keymaps/supercoder/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/ergodox_ez/keymaps/supercoder/README.md b/keyboards/ergodox_ez/keymaps/supercoder/README.md
new file mode 100644
index 0000000000..97bf7f5835
--- /dev/null
+++ b/keyboards/ergodox_ez/keymaps/supercoder/README.md
@@ -0,0 +1,29 @@
+SuperCoder 2000 layout for the ErgoDox
+==================================================
+
+![SuperCoder 2000](images/supercoder_2000.jpg)
+
+Ever found yourself in need of entering binary codes rapidly? Ever wanted to use
+all ten fingers to do so? Ever felt your SuperCoder 2000 too limiting, by only
+having three buttons? We heard you! With this layout for the ErgoDox EZ, you
+will be able to tap in binary at an unparalleled speed and accuracy! Efficiency
+never seen before!
+
+Behold the Ultimate SuperCoder 2000 layout!
+
+![SuperCoder layout](images/layout.png)
+
+### To use it...
+
+To use this piece of top quality engineering, you can either
+[download the hex file][hex] we have prepared for you, or you can compile it on
+your own:
+
+ [hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex
+
+```
+$ git clone https://github.com/jackhumbert/qmk_firmware.git
+$ cd qmk_firmware/keyboards/ergodox_ez
+$ git clone https://github.com/algernon/ergodox-supercoder.git keymaps/supercoder
+$ make KEYMAP=supercoder
+```