]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/bone2planck/readme.md
[Keyboard] Add QMK configurator JSON for Alice PCB (#6397)
[qmk_firmware.git] / keyboards / planck / keymaps / bone2planck / readme.md
1 Bone2Planck
2 =====================================
3
4 This layout tries to emulate the Bone2 variant of 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 inspired by the Neo2 layers,
7 designed to keep the fingers near the home row.
8
9 Bone2 wiki page: http://wiki.neo-layout.org/wiki/Bone
10
11 To build, run "make" from within the \bone2planck folder.
12
13 ## Bone2 (adapted) Base Layer
14 ```
15  ,-----------------------------------------------------------------------------------.
16  |  ß   |   J  |   D  |   U  |   A  |   X  |   P  |   H  |   L  |   M  |   W  |  Q   |
17  |------+------+------+------+------+-------------+------+------+------+------+------|
18  |  M1  |   C  |   T  |   I  |   E  |   O  |   B  |   N  |   R  |   S  |   G  |M1/Ent| hold: M1, tap: Enter
19  |------+------+------+------+------+------|------+------+------+------+------+------|
20  | Shift|   F  |   V  |   Ü  |   Ä  |   Ö  |   Y  |   Z  |   ,  |   .  |   K  |Shift |
21  |------+------+------+------+------+------+------+------+------+------+------+------|
22  | Ctrl | GUI  | Alt  |  M4  |  M2  |    Space    |  M2  |  M4  | Alt  | Esc  | Ctrl |
23  `-----------------------------------------------------------------------------------'
24 ```
25
26 ## M1 Special Characters
27   very ergonomic placement for coding
28 ```
29  ,-----------------------------------------------------------------------------------.
30  |  °   |   @  |   _  |   [  |   ]  |   ^  |   !  |   <  |   >  |   =  |   &  |  ´   |
31  |------+------+------+------+------+-------------+------+------+------+------+------|
32  |  M1  |   \  |   /  |   {  |   }  |   *  |   ?  |   (  |   )  |   -  |   :  |M1/Ent| hold: M1, tap: Enter
33  |------+------+------+------+------+------|------+------+------+------+------+------|
34  | Shift|   #  |   ~  |   |  |   $  |   €  |   +  |   %  |   "  |   '  |   ;  |Shift |
35  |------+------+------+------+------+------+------+------+------+------+------+------|
36  | Ctrl | GUI  | Alt  |  M4  |  M2  |    Space    |  M2  |  M4  | Alt  | Esc  | Ctrl |
37  `-----------------------------------------------------------------------------------'
38 ```
39
40 ## M2 Navigation & Number Blocks
41   very easy to get used to & intuituve placement
42 ```
43  ,-----------------------------------------------------------------------------------.
44  |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |   7  |   8  |   9  |      | Ins  |
45  |------+------+------+------+------+-------------+------+------+------+------+------|
46  |  Tab | Home |  Lft | Down | Right| End  |      |   4  |   5  |   6  |   .  | Enter|
47  |------+------+------+------+------+------|------+------+------+------+------+------|
48  | Shift|      |  Tab |      | Enter|      |   0  |   1  |   2  |   3  |   ,  |Shift |
49  |------+------+------+------+------+------+------+------+------+------+------+------|
50  | Ctrl | GUI  | Alt  |  M3  |  M2  |    Space    |  M2  |  M3  | Alt  | Esc  | Ctrl |
51  `-----------------------------------------------------------------------------------'
52 ```
53
54 ## M4 Function & Media Keys
55 ```
56  ,-----------------------------------------------------------------------------------.
57  |      |      | Print|Scroll|Pause |      |      |  F7  |  F8  |  F9  |  F12 |      |
58  |------+------+------+------+------+-------------+------+------+------+------+------|
59  |  Tab |      | Mute | Vol- | Vol+ |      |   ³  |  F4  |  F5  |  F6  |  F11 | Enter|
60  |------+------+------+------+------+------|------+------+------+------+------+------|
61  | Shift|      | Prev | Play | Next |      |   ²  |  F1  |  F2  |  F3  |  F10 |Shift |
62  |------+------+------+------+------+------+------+------+------+------+------+------|
63  | Ctrl | GUI  | Alt  |  M4  |  M5  |    Space    |  M5  |  M4  | Alt  | Esc  | Ctrl |
64  `-----------------------------------------------------------------------------------'
65 ```
66
67
68 ##Switched layers for one handed access:
69
70 ### M3 Switched Navigation & Number Blocks
71   accessed by sliding from M2 to M3 with thumb
72 ```
73  ,-----------------------------------------------------------------------------------.
74  | Ins  |      |  7   |  8   |  9   |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |
75  |------+------+------+------+------+-------------+------+------+------+------+------|
76  |  Tab |      |  4   |  5   |  6   |   .  | Home | Left | Down | Right| End  | Enter|
77  |------+------+------+------+------+------|------+------+------+------+------+------|
78  | Shift|  0   |  1   |  2   |  3   |   ,  |      | Tab  |      | Enter|      |Shift |
79  |------+------+------+------+------+------+------+------+------+------+------+------|
80  | Ctrl | GUI  | Alt  |  M3  |      |    Space    |      |  M3  | Alt  | Esc  | Ctrl |
81  `-----------------------------------------------------------------------------------'
82 ```
83
84 ### M5 Switched Function & Media Keys
85   accessed by sliding from M4 to M5 with thumb
86 ```
87  ,-----------------------------------------------------------------------------------.
88  |      |      |  F7  |  F8  |  F9  |  F12 |      | Print|Scroll| Pause|      |      |
89  |------+------+------+------+------+-------------+------+------+------+------+------|
90  |  Tab |  ³   |  F4  |  F5  |  F6  |  F11 |      | Mute | Vol- | Vol+ |      | Enter|
91  |------+------+------+------+------+------|------+------+------+------+------+------|
92  | Shift|  ²   |  F1  |  F2  |  F3  |  F10 |      | Prev | Play | Next |      |Shift |
93  |------+------+------+------+------+------+------+------+------+------+------+------|
94  | Ctrl | GUI  | Alt  |      |  M5  |    Space    |  M5  |      | Alt  | Esc  | Ctrl |
95  `-----------------------------------------------------------------------------------'
96 ```