]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/neo2planck/readme.md
Debounce refactor / API (#3720)
[qmk_firmware.git] / keyboards / planck / keymaps / neo2planck / readme.md
1 Neo2Planck
2 =====================================
3
4 This layout tries to emulate Neo2, and is intended to be used with a German QWERTZ softwarelayout.
5 It has "üäöß" as it is optimized for a mix of German & English.
6 The special character layer and the navigation & number block layer are designed to keep the fingers near the home row.
7
8 This layout has some adaptations, due to the limited keys available: 
9 * function-keys moved to the bottom row
10 * press M1 + M2 to get to layer 3
11
12 Neo2 wiki page: http://wiki.neo-layout.org/
13
14 ## Neo2 Base Layer
15 ```
16  ,-----------------------------------------------------------------------------------.
17  | Esc  |   X  |   V  |   L  |   C  |   W  |   K  |   H  |   G  |   F  |   Q  | Bksp |
18  |------+------+------+------+------+-------------+------+------+------+------+------|
19  | Ent  |   U  |   I  |   A  |   E  |   O  |   S  |   N  |   R  |   T  |   D  |  Y   |
20  |------+------+------+------+------+------|------+------+------+------+------+------|
21  | Shift|   Ü  |   Ö  |   Ä  |   P  |   Z  |   B  |   M  |   ,  |   .  |   J  |Shift |
22  |------+------+------+------+------+------+------+------+------+------+------+------|
23  | Ctrl | GUI  | Alt  |  M2  |  M1  |    Space    |  M1  |  M2  | Alt  |MRight| Ctrl |
24  `-----------------------------------------------------------------------------------'
25 ```
26
27 # M1 Special Characters
28 ```
29  ,-----------------------------------------------------------------------------------.
30  |  Esc |      |   _  |   [  |   ]  |   ^  |   !  |   <  |   >  |   =  |   &  |  ß   |
31  |------+------+------+------+------+-------------+------+------+------+------+------|
32  |  Tab |   \  |   /  |   {  |   }  |   *  |   ?  |   (  |   )  |   -  |   :  |  @   | 
33  |------+------+------+------+------+------|------+------+------+------+------+------|
34  | Shift|   #  |   $  |   |  |   ~  |   `  |   +  |   %  |   "  |   '  |   ;  |Shift |
35  |------+------+------+------+------+------+------+------+------+------+------+------|
36  | Ctrl | GUI  | Alt  |  M2  |  M1  |    Space    |  M1  |  M2  | Alt  | Esc  | Ctrl |
37  `-----------------------------------------------------------------------------------'
38 ```
39
40 ## M2 Navigation & Number Blocks
41 ```
42  ,-----------------------------------------------------------------------------------.
43  |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |   7  |   8  |   9  |      | Ins  |
44  |------+------+------+------+------+-------------+------+------+------+------+------|
45  |  Tab | Home |  Lft | Down | Right| End  |      |   4  |   5  |   6  |   .  | Enter|
46  |------+------+------+------+------+------|------+------+------+------+------+------|
47  | Shift|      |  Tab |      | Enter|      |   0  |   1  |   2  |   3  |   ,  |Shift |
48  |------+------+------+------+------+------+------+------+------+------+------+------|
49  | Ctrl | GUI  | Alt  |  M2  |  M1  |    Space    |  M1  |  M2  | Alt  | Esc  | Ctrl |
50  `-----------------------------------------------------------------------------------'
51 ```
52
53 ## M3 F-Keys and Media-Keys
54 ```
55  ,-----------------------------------------------------------------------------------.
56  |      |      | Print|Scroll|Pause |      |      |  F7  |  F8  |  F9  |  F12 |      |
57  |------+------+------+------+------+-------------+------+------+------+------+------|
58  | Tab  |      | Mute | Vol- | Vol+ |      |   ³  |  F4  |  F5  |  F6  |  F11 | Enter|
59  |------+------+------+------+------+------|------+------+------+------+------+------|
60  | Shift|      | Prev | Play | Next |      |   ²  |  F1  |  F2  |  F3  |  F10 |Shift |
61  |------+------+------+------+------+------+------+------+------+------+------+------|
62  | Ctrl | GUI  | Alt  |  M2  |  M1  |    Space    |  M1  |  M2  | Alt  | Esc  | Ctrl |
63  `-----------------------------------------------------------------------------------'
64 ```