summaryrefslogtreecommitdiff
path: root/keyboards/helix/rev3_4rows/keymaps/default/readme.md
diff options
context:
space:
mode:
authorMakotoKurauchi <pluis@me.com>2020-10-12 11:37:31 +0900
committerGitHub <noreply@github.com>2020-10-12 11:37:31 +0900
commit4f923b1673fe35644af3dfe5c8e2a766116e0012 (patch)
treeb2890b314456bb0c456cb73133b1e996a925e29a /keyboards/helix/rev3_4rows/keymaps/default/readme.md
parentcacf495c91c7f6ad0e31edcefa8355eba98f75b6 (diff)
[Keyboard] Add Helix rev3 (#10297)
* add Helix Type-R keyboard * add default 4Rows keymaps * cleanup 4row keymaps * update about SPLIT_HAND_MATRIX_GRID and DIP_SWITCH_MATRIX_GRID * change how to toggle mac/win * update "Hardware Availability" * add a section of "How to build" * update "Hardware Supported" * add dip-sw sections * comment updated in function `encoder_update_user` * revert how to toggle mac/win * remove 4Rows variant build options * rename helix_type_r to helix_5r * add helix type-R 4Rows edition * small modifications in keymap.c * small modifications according to renaming * change project root directory * continuous work on ee2c39f1f9bffd97a2deb8f430746933a8d8684c * cleanup unused files * update info.json files * cleanup 5rows' keymaps * rename and update readme.md * update config.h * update helix's readme.md and rules.mk * update keymaps' overviews * split into each keyboard * optimize firmware size for via keymaps * fix LAYOUT to LAYOUT4 in 4rows/rev3.h * remove LAYOUT_kc lines from both keymaps * rename tyep-r to rev3 * enable to SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT * remove image from readme * clean up for PR * delete unnecessary comments * change keyboard directory * rename LAYOUT4 to LAYOUT for rev3_4rows * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/rules.mk Co-authored-by: Drashna Jaelre <drashna@live.com> * Cleanup ADJUST Layer code for VIA * change SEND_STRING to tap_code * update readme * moved the oled code from the keymap to the keyboard * moved the dip switch code from the keymap to the keyboard * change layout name for info.json * Update keyboards/helix/rev3_4rows/rev3_4rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/rev3_4rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/rev3_4rows.h Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/rev3_5rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/rev3_5rows.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/rev3_5rows.h Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/default/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/keymaps/via/keymap.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_5rows/info.json Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_5rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rules.mk Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/helix/rev3_4rows/config.h Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update keyboards/helix/rev3_4rows/oled_display.c Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * deleted key_count in info.json Co-authored-by: keyaki-namiki <28521374+keyaki-namiki@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat (limited to 'keyboards/helix/rev3_4rows/keymaps/default/readme.md')
-rw-r--r--keyboards/helix/rev3_4rows/keymaps/default/readme.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/keyboards/helix/rev3_4rows/keymaps/default/readme.md b/keyboards/helix/rev3_4rows/keymaps/default/readme.md
new file mode 100644
index 0000000000..e747096851
--- /dev/null
+++ b/keyboards/helix/rev3_4rows/keymaps/default/readme.md
@@ -0,0 +1,66 @@
+# The default keymap for Helix rev3 4rows
+
+### Qwerty Layer (Base)
+```
+,-----------------------------------------. ,-----------------------------------------.
+| Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| Shift| Z | X | C | V | B | | N | M | , | . | / |Enter |
+|------+------+------+------+------+------+-------------+------+------+------+------+------+------|
+|Adjust| Esc | Alt | GUI | EISU |Lower |Space |Space |Raise | KANA | Left | Down | Up |Right |
+`-------------------------------------------------------------------------------------------------'
+```
+### Lower Layer
+```
+,-----------------------------------------. ,-----------------------------------------.
+| ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| | F1 | F2 | F3 | F4 | F5 | | F6 | _ | + | { | } | | |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| CAPS | F7 | F8 | F9 | F10 | F11 | | F12 | | | Home | End | |
+|------+------+------+------+------+------+-------------+------+------+------+------+------+------|
+| | | | | | | | | | | Next | Vol- | Vol+ | Play |
+`-------------------------------------------------------------------------------------------------'
+```
+### Raise Layer
+```
+,-----------------------------------------. ,-----------------------------------------.
+| ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| CAPS | F7 | F8 | F9 | F10 | F11 | | F12 | | |PageDn|PageUp| |
+|------+------+------+------+------+------+-------------+------+------+------+------+------+------|
+| | | | | | | | | | | Next | Vol- | Vol+ | Play |
+`-------------------------------------------------------------------------------------------------'
+```
+### Adjust Layer (Lower + Raise)
+```
+,-----------------------------------------. ,-----------------------------------------.
+| F1 | F2 | F3 | F4 | F5 | F6 | | F7 | F8 | F9 | F10 | F11 | F12 |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| | Reset|RGBRST|EEPRST| | | | | | | | | Del |
+|------+------+------+------+------+------| |------+------+------+------+------+------|
+| | | | | | Mac | | Win | |RGB ON| HUE+ | SAT+ | VAL+ |
+|------+------+------+------+------+------+------+------+------+------+------+------+------+------|
+| | | | | | | | | | | MODE | HUE- | SAT- | VAL- |
+`-------------------------------------------------------------------------------------------------'
+```
+
+### Rotary Encoder Settings
+
+|L/R|Clockwise|Counter Clockwise|
+|---|---|---|
+|Left|Page Down|Page Up|
+|Right|Down|Up|
+
+### DipSW Settings
+
+|Switch No.||
+|---|---|
+|Left 1|Toggle Win/mac|
+|Left 2|Not assigned|
+|Right 1|Not assigned|
+|Right 2|Not assigned|