summaryrefslogtreecommitdiffstats
path: root/keyboards/e6v2/le/keymaps/johu/readme.md
diff options
context:
space:
mode:
authorAlex Ong <the.onga@gmail.com>2019-01-04 09:43:45 +0100
committerAlex Ong <the.onga@gmail.com>2019-01-04 09:43:45 +0100
commit2bb2977c133646c4e056960e72029270d77cc1eb (patch)
tree235d491f992121ac1716c5bf2fafb80983748576 /keyboards/e6v2/le/keymaps/johu/readme.md
parenta55c838961c89097ab849ed6cb1f261791e6b9b4 (diff)
parent47c91fc7f75ae0a477e55b687aa0fc30da0a283c (diff)
downloadqmk_firmware-2bb2977c133646c4e056960e72029270d77cc1eb.tar.gz
qmk_firmware-2bb2977c133646c4e056960e72029270d77cc1eb.tar.xz
Merge branch 'master' into debounce_refactor
# Conflicts: # tmk_core/common/keyboard.c
Diffstat (limited to 'keyboards/e6v2/le/keymaps/johu/readme.md')
-rw-r--r--keyboards/e6v2/le/keymaps/johu/readme.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/keyboards/e6v2/le/keymaps/johu/readme.md b/keyboards/e6v2/le/keymaps/johu/readme.md
new file mode 100644
index 000000000..605a14a1c
--- /dev/null
+++ b/keyboards/e6v2/le/keymaps/johu/readme.md
@@ -0,0 +1,40 @@
+# johu's E6-V2 Last Edition (LE) HHKB
+Make example for this keyboard (after setting up your build environment):
+```bash
+$ make e6v2/le:johu
+```
+
+Or to make and flash:
+```bash
+$ make e6v2/le:johu:dfu
+```
+
+See the [build environment setup] and the [make instructions] for more
+information. Brand new to QMK? Start with our [Complete Newbs Guide].
+
+## Layer 0: Base Layer
+* HHKB Qwerty layout plus some specials:
+ * The Space key sends `Space` when tapped, toggles to *Space FN Layer* when held
+ * [Grave Escape]
+ * The Ctrl key sends `Esc` when tapped, `Ctrl` when held
+ * The Tab key sends `Tab` when tapped, [Hyper] (`Super+Ctrl+Alt+Shift`) when held
+ * The right Shift key sends `Enter` when tapped, `Shift` when held
+
+## Layer 1: Function Layer
+* Default HHKB function layer includig the iconic diamond arrow cluster
+* Multimedia controls
+
+## Layer 2: Space FN Layer
+* VIM style arrow cluster
+* Multimedia controls
+
+## Layer 3: Control Layer
+* Reset button
+* RGB controls
+* Caps Lock
+
+[build environment setup]: https://docs.qmk.fm/#/getting_started_build_tools
+[make instructions]: https://docs.qmk.fm/#/getting_started_make_guide
+[Complete Newbs Guide]: https://docs.qmk.fm/#/newbs
+[Grave Escape]: https://beta.docs.qmk.fm/features/feature_grave_esc
+[Hyper]: http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key