summaryrefslogtreecommitdiffstats
path: root/keyboards/helix/rev2/keymaps/five_rows/README.md
diff options
context:
space:
mode:
authorTakeshi ISHII <2170248+mtei@users.noreply.github.com>2018-03-24 00:08:37 +0100
committerDrashna Jaelre <drashna@live.com>2018-03-24 00:08:37 +0100
commit824d584d8cf20337350f657e849aa2a9b4b68ed0 (patch)
treeef2b32c31011ccc1cfd03511d855c29c2aa6d1d3 /keyboards/helix/rev2/keymaps/five_rows/README.md
parent3a49ad06cdd1898acd23bc893b3caa14674a1fff (diff)
downloadqmk_firmware-824d584d8cf20337350f657e849aa2a9b4b68ed0.tar.gz
qmk_firmware-824d584d8cf20337350f657e849aa2a9b4b68ed0.tar.xz
New keymap for The Helix keyboard("five_rows") (#2592)
* duplicate keyboards/helix/rev2/keymaps/default to keyboards/helix/rev2/keymaps/five_rows * OLED Layer display 'Qwerty','Colemak','Dvorak' * set Qwerty, Lower, Raise map * set Colemak map * set Dvorak map * OLED Layer display 'Raise','Lower' change to 'Extra char','Function' * fix ExtraChar Layer Shift-key disable * Raise,Lower,Adjust layer modify some key change KC_TRNS to KC_NO add KANA, EISU key * refine keymaps/five_rows/{config.h,rules.mk} for easy and safe customize * modify Adjust layer: all function into left hand, remove F1..F12,DEL * Add Helix five_rows keymap README.md and README_jp.md * Raise Layer modify: enable Raise(Extr)+Lower(Func)==Adjust * fix image file url in README.md,README_jp.md * change Layer display on OLED * change OLED display base name position
Diffstat (limited to 'keyboards/helix/rev2/keymaps/five_rows/README.md')
-rw-r--r--keyboards/helix/rev2/keymaps/five_rows/README.md73
1 files changed, 73 insertions, 0 deletions
diff --git a/keyboards/helix/rev2/keymaps/five_rows/README.md b/keyboards/helix/rev2/keymaps/five_rows/README.md
new file mode 100644
index 000000000..edb768f3b
--- /dev/null
+++ b/keyboards/helix/rev2/keymaps/five_rows/README.md
@@ -0,0 +1,73 @@
+# Keymap for 5 rows Helix keyboard
+
+This keymap is only for 5 rows Helix keyboard.
+
+## Layout
+
+![fig1](https://gist.github.com/mtei/c81a3688206aa50996339cb9ced4751d/raw/662082b66231eb8d1f45776d813c57f29d445e68/helix-five_rows_r2.png)
+
+## Layer
+
+|Priority|Number|Name|Discription|
+| ---- | ---- | --- | --- |
+|high|16|Adjust| keyboard local functions|
+||4|Extra char| some charactors |
+||3|Function| function keys |
+||2|Dvorak|Dvorak|
+||1|Colemak|Colemak|
+|low|0|Qwerty|QWERTY (base)|
+
+### Adjust Layer
+
+Adjust Layer has keyboard local function keys.
+
+* LED control.
+* Mac/Win mode change.
+* Qwerty/Colemak/Dvorak change.
+
+### Mac mode and Win mode
+
+Mac mode swap Alt/Win(GUI) key.
+
+|mode|key|code|
+| ---- | ---- | --- |
+|Mac mode|Adjust + g(Qwerty)|AG_NORM|
+|Win mode|Adjust + h(Qwerty)|AG_SWAP|
+| |Adjust + t(Qwerty)| |
+
+### LED control
+
+|command|key|code|
+| ---- | ---- | --- |
+|on/off|Adjust + ,(Qwerty)|RGB_TOG|
+| |Adjust + v(Qwerty)| |
+|change mode|Adjust + Right option |RGB_SMOD|
+| |Adjust + c(Qwerty)| |
+|HUE +|Adjust + .(Qwerty) |RGB_HUI|
+| |Adjust + Left Control| |
+|HUE -|Adjust + menu |RGB_HUD|
+| |Adjust + Left Shift | |
+|SAT +|Adjust + /(Qwerty) |RGB_SAI|
+| |Adjust + a(Qwerty) | |
+|SAT -|Adjust + right hand left side Fn|RGB_SAD|
+| |Adjust + z(Qwerty) | |
+|Bright +|Adjust + Right Shift |RGB_VAI|
+| |Adjust + s(Qwerty)| |
+|Bright -|Adjust + right hand right side Fn|RGB_VAD|
+| |Adjust + x(Qwerty) | |
+|reset|Adjust + w(Qwerty)|RGBRST|
+
+### Qwerty, Colemak, Dvorak selection
+
+|char layout|key|
+| ---- | ---- |
+|Qwerty | Adjust + j(Qwerty) |
+| | Adjust + 5|
+|Calemak| Adjust + k(Qwerty) |
+| | Adjust + 4|
+|Dvorak | Adjust + l(Qwerty) |
+| | Adjust + 3|
+
+## Note
+
+![fig2](https://gist.github.com/mtei/c81a3688206aa50996339cb9ced4751d/raw/9979482e9aa0b25962fad9ee634cd1c23cef1751/five_rows_making.jpg)