diff options
Diffstat (limited to 'keyboards/helix/pico/keymaps/default/readme.md')
-rw-r--r-- | keyboards/helix/pico/keymaps/default/readme.md | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/keyboards/helix/pico/keymaps/default/readme.md b/keyboards/helix/pico/keymaps/default/readme.md new file mode 100644 index 000000000..13948cf62 --- /dev/null +++ b/keyboards/helix/pico/keymaps/default/readme.md | |||
@@ -0,0 +1,128 @@ | |||
1 | # The Default HelixPico Layout | ||
2 | ## Layout | ||
3 | |||
4 | ### Qwerty | ||
5 | ``` | ||
6 | ,-----------------------------------------. ,-----------------------------------------. | ||
7 | | Tab | Q | W | E | R | T | | Y | U | I | O | P | Bksp | | ||
8 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
9 | | Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' | | ||
10 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
11 | | Shift| Z | X | C | V | B | | N | M | , | . | / |Enter | | ||
12 | |------+------+------+------+------+------+-------------+------+------+------+------+------+------| | ||
13 | |Adjust| Esc | Alt | GUI | EISU |Lower |Space |Space |Raise | KANA | Left | Down | Up |Right | | ||
14 | `-------------------------------------------------------------------------------------------------' | ||
15 | ``` | ||
16 | |||
17 | ### Colemak | ||
18 | ``` | ||
19 | ,-----------------------------------------. ,-----------------------------------------. | ||
20 | | Tab | Q | W | F | P | G | | J | L | U | Y | ; | Bksp | | ||
21 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
22 | | Ctrl | A | R | S | T | D | | H | N | E | I | O | ' | | ||
23 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
24 | | Shift| Z | X | C | V | B | | K | M | , | . | / |Enter | | ||
25 | |------+------+------+------+------+------+-------------+------+------+------+------+------+------| | ||
26 | |Adjust| Esc | Alt | GUI | EISU |Lower |Space |Space |Raise | KANA | Left | Down | Up |Right | | ||
27 | `-------------------------------------------------------------------------------------------------' | ||
28 | ``` | ||
29 | |||
30 | ### Dvorak | ||
31 | ``` | ||
32 | ,-----------------------------------------. ,-----------------------------------------. | ||
33 | | Tab | ' | , | . | P | Y | | F | G | C | R | L | Bksp | | ||
34 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
35 | | Ctrl | A | O | E | U | I | | D | H | T | N | S | / | | ||
36 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
37 | | Shift| ; | Q | J | K | X | | B | M | W | V | Z |Enter | | ||
38 | |------+------+------+------+------+------+-------------+------+------+------+------+------+------| | ||
39 | |Adjust| Esc | Alt | GUI | EISU |Lower |Space |Space |Raise | KANA | Left | Down | Up |Right | | ||
40 | `-------------------------------------------------------------------------------------------------' | ||
41 | ``` | ||
42 | |||
43 | ## Layers | ||
44 | |||
45 | |Priority|number|name|description| | ||
46 | | ---- | ---- | --- | --- | | ||
47 | |high|16|Adjust|Functions| | ||
48 | ||4|Raise|Numeric charactors| | ||
49 | ||3|Lower|Other charactors| | ||
50 | ||2|Dvorak|Dvorak leyout| | ||
51 | ||1|Colemak|Colemak leyout| | ||
52 | |low|0|Qwerty|QWERTY leyout(base)| | ||
53 | |||
54 | ### Lower | ||
55 | ``` | ||
56 | ,-----------------------------------------. ,-----------------------------------------. | ||
57 | | ~ | ! | @ | # | $ | % | | ^ | & | * | ( | ) | Del | | ||
58 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
59 | | | F1 | F2 | F3 | F4 | F5 | | F6 | _ | + | { | } | | | | ||
60 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
61 | | | F7 | F8 | F9 | F10 | F11 | | F12 | | PrSc | Home | End | | | ||
62 | |------+------+------+------+------+------+-------------+------+------+------+------+------+------| | ||
63 | | | | | | | | | | | | Next | Vol- | Vol+ | Play | | ||
64 | `-------------------------------------------------------------------------------------------------' | ||
65 | ``` | ||
66 | |||
67 | ### Raise | ||
68 | ``` | ||
69 | ,-----------------------------------------. ,-----------------------------------------. | ||
70 | | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | Del | | ||
71 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
72 | | | F1 | F2 | F3 | F4 | F5 | | F6 | - | = | [ | ] | \ | | ||
73 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
74 | | | F7 | F8 | F9 | F10 | F11 | | F12 | | PrSc |PageDn|PageUp| | | ||
75 | |------+------+------+------+------+------+-------------+------+------+------+------+------+------| | ||
76 | | | | | | | | | | | | Next | Vol- | Vol+ | Play | | ||
77 | `-------------------------------------------------------------------------------------------------' | ||
78 | ``` | ||
79 | |||
80 | ### Adjust (Lower + Raise) | ||
81 | ``` | ||
82 | ,-----------------------------------------. ,-----------------------------------------. | ||
83 | | | Reset| | | | | | | | | | | | | ||
84 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
85 | | |Aud on|Audoff|MU TOG|MU MOD| Mac | | Win |Qwerty|Colemk|Dvorak| | | | ||
86 | |------+------+------+------+------+------| |------+------+------+------+------+------| | ||
87 | | |CK TOG|CK RST| CK UP|CK DWN| | | | |RGB ON| HUE+ | SAT+ | VAL+ | | ||
88 | |------+------+------+------+------+------+-------------+------+------+------+------+------+------| | ||
89 | | | | | | | | | | | | MODE | HUE- | SAT- | VAL- | | ||
90 | `-------------------------------------------------------------------------------------------------' | ||
91 | ``` | ||
92 | |||
93 | ## Customize | ||
94 | |||
95 | see `qmk_firmware/keyboards/helix/pico/keymaps/default/rules.mk` | ||
96 | |||
97 | ``` | ||
98 | # Helix keyboard customize | ||
99 | # you can edit follows 6 Variables | ||
100 | # jp: 以下の6つの変数を必要に応じて編集します。 | ||
101 | OLED_ENABLE = no # OLED_ENABLE | ||
102 | LOCAL_GLCDFONT = no # use each keymaps "helixfont.h" insted of "common/glcdfont.c" | ||
103 | LED_BACK_ENABLE = no # LED backlight (Enable WS2812 RGB underlight.) | ||
104 | LED_UNDERGLOW_ENABLE = no # LED underglow (Enable WS2812 RGB underlight.) | ||
105 | LED_ANIMATIONS = yes # LED animations | ||
106 | IOS_DEVICE_ENABLE = no # connect to IOS device (iPad,iPhone) | ||
107 | |||
108 | ``` | ||
109 | ## Compile | ||
110 | |||
111 | go to qmk top directory. | ||
112 | ``` | ||
113 | $ cd qmk_firmware | ||
114 | ``` | ||
115 | |||
116 | build | ||
117 | ``` | ||
118 | $ make helix/pico:default | ||
119 | ``` | ||
120 | |||
121 | flash to keyboard | ||
122 | ``` | ||
123 | $ make helix/pico:default:avrdude | ||
124 | ``` | ||
125 | |||
126 | ## Link | ||
127 | * more detail wrote in Japanese [helix/Doc/firmware_jp.md](https://github.com/MakotoKurauchi/helix/blob/master/Doc/firmware_jp.md) | ||
128 | * [Helix top](https://github.com/MakotoKurauchi/helix) | ||