]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/planck/keymaps/bone2planck/readme.md
updated readme
[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 * | Q    |   J  |   D  |   U  |   A  |   X  |   P  |   H  |   L  |   M  |   W  |  ẞ   |
16 * |------+------+------+------+------+-------------+------+------+------+------+------|
17 * |M1/Tab|   C  |   T  |   I  |   E  |   O  |   B  |   N  |   R  |   S  |   G  |M1/Ent|  //hold for M1, tap for Tab/Enter
18 * |------+------+------+------+------+------|------+------+------+------+------+------|
19 * | Shift|   F  |   V  |   Ü  |   Ä  |   Ö  |   Y  |   Z  |   ,  |   .  |   K  |Shift |
20 * |------+------+------+------+------+------+------+------+------+------+------+------|
21 * | Ctrl | GUI  | Alt  |  M4  |  M2  |    Space    |  M2  |  M4  | Alt  | Esc  | Ctrl |
22 * `-----------------------------------------------------------------------------------'
23
24 ## M1 Special Characters
25 *  very ergonomic placement for coding
26 * ,-----------------------------------------------------------------------------------.
27 * | °    |   @  |   _  |   [  |   ]  |   ^  |   !  |   <  |   >  |   =  |   &  |  ´   |
28 * |------+------+------+------+------+-------------+------+------+------+------+------|
29 * |M1/Tab|   \  |   /  |   {  |   }  |   *  |   ?  |   (  |   )  |   -  |   :  |M1/Ent|  //hold for M1, tap for Tab/Enter
30 * |------+------+------+------+------+------|------+------+------+------+------+------|
31 * | Shift|   #  |   $  |   |  |   ~  |   €  |   +  |   %  |   "  |   '  |   ;  |Shift |
32 * |------+------+------+------+------+------+------+------+------+------+------+------|
33 * | Ctrl | GUI  | Alt  |  M4  |  M2  |    Space    |  M2  |  M4  | Alt  | Esc  | Ctrl |
34 * `-----------------------------------------------------------------------------------'
35
36 ## M2 Navigation & Number Blocks
37 *  very easy to get used to & intuituve placement
38 * ,-----------------------------------------------------------------------------------.
39 * |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |   7  |   8  |   9  |      | Ins  |
40 * |------+------+------+------+------+-------------+------+------+------+------+------|
41 * |  Tab | Home |  Lft | Down | Right| End  |   .  |   4  |   5  |   6  |   ,  | Enter|
42 * |------+------+------+------+------+------|------+------+------+------+------+------|
43 * | Shift|      |  Tab |      | Enter|      |   0  |   1  |   2  |   3  |   ;  |Shift |
44 * |------+------+------+------+------+------+------+------+------+------+------+------|
45 * | Ctrl | GUI  | Alt  |  M3  |  M2  |    Space    |  M2  |  M3  | Alt  | Esc  | Ctrl |
46 * `-----------------------------------------------------------------------------------'
47
48 ## M4 Function & Media Keys
49 * ,-----------------------------------------------------------------------------------.
50 * |      |      | Print|Scroll|Pause |      |      |  F7  |  F8  |  F9  |  F12 |      |
51 * |------+------+------+------+------+-------------+------+------+------+------+------|
52 * |      |      | Mute | Vol- | Vol+ |      |   ³  |  F4  |  F5  |  F6  |  F11 |      |
53 * |------+------+------+------+------+------|------+------+------+------+------+------|
54 * | Shift|      | Prev | Play | Next |      |   ²  |  F1  |  F2  |  F3  |  F10 |Shift |
55 * |------+------+------+------+------+------+------+------+------+------+------+------|
56 * | Ctrl | GUI  | Alt  |  M4  |  M5  |    Space    |  M5  |  M4  | Alt  | Esc  | Ctrl |
57 * `-----------------------------------------------------------------------------------'
58
59
60
61 ##Switched layers for one handed access:
62
63 ### M3 Switched Navigation & Number Blocks for one handed use
64 *  accessed by sliding from M2 to M3 with thumb
65 * ,-----------------------------------------------------------------------------------.
66 * | Ins  |      |  7   |  8   |  9   |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |
67 * |------+------+------+------+------+-------------+------+------+------+------+------|
68 * |  Tab |  .   |  4   |  5   |  6   |   ,  | Home | Left | Down | Right| End  | Enter|
69 * |------+------+------+------+------+------|------+------+------+------+------+------|
70 * | Shift|  0   |  1   |  2   |  3   |   ;  |      | Tab  |  Ins | Enter|      |Shift |
71 * |------+------+------+------+------+------+------+------+------+------+------+------|
72 * | Ctrl | GUI  | Alt  |  M3  |      |    Space    |      |  M3  | Alt  | Esc  | Ctrl |
73 * `-----------------------------------------------------------------------------------'
74
75 ### M5 Switched Function & Media Keys|
76 *  accessed by sliding from M4 to M5 with thumb
77 * ,-----------------------------------------------------------------------------------.
78 * |      |      |  F7  |  F8  |  F9  |  F12 |      | Print|Scroll| Pause|      |      |
79 * |------+------+------+------+------+-------------+------+------+------+------+------|
80 * |      |  ³   |  F4  |  F5  |  F6  |  F11 |      | Mute | Vol- | Vol+ |      |      |
81 * |------+------+------+------+------+------|------+------+------+------+------+------|
82 * | Shift|  ²   |  F1  |  F2  |  F3  |  F10 |      | Prev | Play | Next |      |Shift |
83 * |------+------+------+------+------+------+------+------+------+------+------+------|
84 * | Ctrl | GUI  | Alt  |      |  M5  |    Space    |  M5  |      | Alt  | Esc  | Ctrl |
85 * `-----------------------------------------------------------------------------------'