updated bone2planck keymap & readme

4 files changed, 98 insertions, 26 deletions

diff --git a/keyboards/planck/keymaps/bone2planck/Makefile b/keyboards/planck/keymaps/bone2planck/Makefile
index cf2c31f0f..39635192e 100644
--- a/keyboards/planck/keymaps/bone2planck/Makefile
+++ b/keyboards/planck/keymaps/bone2planck/Makefile
@@ -1,20 +1,16 @@
-# Please remove if no longer applicable
-$(warning THIS FILE MAY BE TOO LARGE FOR YOUR KEYBOARD)
-$(warning Please disable some options in the Makefile to resolve)
-
 # Build Options
-#   change to "no" to disable the options, or define them in the Makefile in 
+#   change to "no" to disable the options, or define them in the Makefile in
 #   the appropriate keymap folder that will get included automatically
 #
 BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
-MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
+MOUSEKEY_ENABLE = no       # Mouse keys(+4700)
 EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
 CONSOLE_ENABLE = no         # Console for debug(+400)
-COMMAND_ENABLE = yes        # Commands for debug and configuration
+COMMAND_ENABLE = no        # Commands for debug and configuration
 NKRO_ENABLE = yes            # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
-BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+BACKLIGHT_ENABLE = no      # Enable keyboard backlight functionality
 MIDI_ENABLE = no            # MIDI controls
-AUDIO_ENABLE = yes           # Audio output on port C6
+AUDIO_ENABLE = no           # Audio output on port C6
 UNICODE_ENABLE = no         # Unicode
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
diff --git a/keyboards/planck/keymaps/bone2planck/config.h b/keyboards/planck/keymaps/bone2planck/config.h
index 60aff6db0..3e9e692d3 100644
--- a/keyboards/planck/keymaps/bone2planck/config.h
+++ b/keyboards/planck/keymaps/bone2planck/config.h
@@ -1,7 +1,8 @@
 #ifndef CONFIG_USER_H
 #define CONFIG_USER_H
-#endif
 
 #include "../../config.h"
 
-#define PREVENT_STUCK_MODIFIERS
\ No newline at end of file
+#define PREVENT_STUCK_MODIFIERS
+
+#endif
\ No newline at end of file
diff --git a/keyboards/planck/keymaps/bone2planck/keymap.c b/keyboards/planck/keymaps/bone2planck/keymap.c
index 69d164b8c..63fd2f1fc 100644
--- a/keyboards/planck/keymaps/bone2planck/keymap.c
+++ b/keyboards/planck/keymaps/bone2planck/keymap.c
@@ -7,10 +7,10 @@
 // for intellisense, has to be commented for building
 /*
 #include "..\..\..\..\quantum\keymap_extras\keymap_german.h"
-#include "..\..\..\..\quantum\keymap_common.h"
 #include "..\..\..\..\tmk_core\common\keycode.h"
 */
 
+
 #define _______ KC_TRNS
 
 /* This Layout tries to emulate the Bone2 Variant of Neo2, and is intended to be used with a German QWERTZ Softwarelayout.
@@ -23,7 +23,7 @@ Bone2 wiki page: http://wiki.neo-layout.org/wiki/Bone
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-/* Bone2
+/* Bone2 (adapted)
 * ,-----------------------------------------------------------------------------------.
 * | Q    |   J  |   D  |   U  |   A  |   X  |   P  |   H  |   L  |   M  |   W  |  ẞ   |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
@@ -42,7 +42,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 },
 
 /* M1 Special Characters
-very ergonomic placement for coding
+*  very ergonomic placement for coding
 * ,-----------------------------------------------------------------------------------.
 * | °    |   @  |   _  |   [  |   ]  |   ^  |   !  |   <  |   >  |   =  |   &  |  ´   |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
@@ -56,12 +56,12 @@ very ergonomic placement for coding
 [1] = {
 	{ DE_RING, DE_AT,   DE_UNDS, DE_LBRC, DE_RBRC, DE_CIRC, DE_EXLM, DE_LESS, DE_MORE, DE_EQL,  DE_AMPR, DE_ACUT },
 	{ _______, DE_BSLS, DE_SLSH, DE_LCBR, DE_RCBR, DE_ASTR, DE_QST,  DE_LPRN, DE_RPRN, DE_MINS, DE_COLN, _______ },
-	{ _______, DE_HASH, DE_DLR,  DE_PIPE, DE_TILD, DE_EURO, DE_PLUS, DE_PERC, DE_DQOT, DE_QUOT, DE_SCLN, _______ },
+	{ _______, DE_HASH, DE_TILD,  DE_PIPE, DE_DLR, DE_EURO, DE_PLUS, DE_PERC, DE_DQOT, DE_QUOT, DE_SCLN, _______ },
 	{ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ }
 },
 
-/* Navigation & Number Blocks
-very easy to get used to & intuituve placement
+/* M2 Navigation & Number Blocks
+*  very easy to get used to & intuituve placement
 * ,-----------------------------------------------------------------------------------.
 * |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |   7  |   8  |   9  |      | Ins  |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
@@ -79,8 +79,8 @@ very easy to get used to & intuituve placement
 	{ _______, _______, _______, MO(3),   _______, _______, _______, _______, MO(3), _______, _______, _______ }
 },
 
-/* Flipped Navigation & Number Blocks for one handed use
-accessed by sliding from M2 to M3 with thumb
+/* M3 Switched Navigation & Number Blocks for one handed use
+*  accessed by sliding from M2 to M3 with thumb
 * ,-----------------------------------------------------------------------------------.
 * | Ins  |      |  7   |  8   |  9   |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
@@ -100,8 +100,7 @@ accessed by sliding from M2 to M3 with thumb
 },
 
 
-/* Function & Media Keys
-slide from m4 to m5 to access flipped version
+/* M4 Function & Media Keys
 * ,-----------------------------------------------------------------------------------.
 * |      |      | Print|Scroll|Pause |      |      |  F7  |  F8  |  F9  |  F12 |      |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
@@ -120,7 +119,8 @@ slide from m4 to m5 to access flipped version
 },
 
 
-/* flipped Function & Media Keys
+/* M5 Switched Function & Media Keys|
+*  accessed by sliding from M4 to M5 with thumb
 * ,-----------------------------------------------------------------------------------.
 * |      |      |  F7  |  F8  |  F9  |  F12 |      | Print|Scroll| Pause|      |      |
 * |------+------+------+------+------+-------------+------+------+------+------+------|
@@ -139,6 +139,7 @@ slide from m4 to m5 to access flipped version
 }
 };
 
+
 const uint16_t PROGMEM fn_actions[] = {
 
 };
diff --git a/keyboards/planck/keymaps/bone2planck/readme.md b/keyboards/planck/keymaps/bone2planck/readme.md
index 3c425efdd..4d19c3c11 100644
--- a/keyboards/planck/keymaps/bone2planck/readme.md
+++ b/keyboards/planck/keymaps/bone2planck/readme.md
@@ -1,8 +1,82 @@
-check keymap.c to the layers
+Bone2Planck
 
 This Layout tries to emulate the Bone2 Variant of Neo2, and is intended to be used with a German QWERTZ Softwarelayout.
 It has "üäöß" as it is optimized for a mix of German & English.
-My favourite features are the placement of the special characters often used for programming right on the home row
-and the number & navigation block combo, so you never have to move your hands from their home position.
+The special character layer and the navigation & number block layer are inspired by the Neo2 layers,
+designed to keep the fingers near the home row.
 
-Bone2 wiki page: http://wiki.neo-layout.org/wiki/Bone
\ No newline at end of file
+Bone2 wiki page: http://wiki.neo-layout.org/wiki/Bone
+
+* Bone2 (adapted) Base Layer
+* ,-----------------------------------------------------------------------------------.
+* | Q    |   J  |   D  |   U  |   A  |   X  |   P  |   H  |   L  |   M  |   W  |  ẞ   |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* |M1/Tab|   C  |   T  |   I  |   E  |   O  |   B  |   N  |   R  |   S  |   G  |M1/Ent|  //hold for M1, tap for Tab/Enter
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift|   F  |   V  |   Ü  |   Ä  |   Ö  |   Y  |   Z  |   ,  |   .  |   K  |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI  | Alt  |  M4  |  M2  |    Space    |  M2  |  M4  | Alt  | Esc  | Ctrl |
+* `-----------------------------------------------------------------------------------'
+
+* M1 Special Characters
+*  very ergonomic placement for coding
+* ,-----------------------------------------------------------------------------------.
+* | °    |   @  |   _  |   [  |   ]  |   ^  |   !  |   <  |   >  |   =  |   &  |  ´   |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* |M1/Tab|   \  |   /  |   {  |   }  |   *  |   ?  |   (  |   )  |   -  |   :  |M1/Ent|  //hold for M1, tap for Tab/Enter
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift|   #  |   $  |   |  |   ~  |   €  |   +  |   %  |   "  |   '  |   ;  |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI  | Alt  |  M4  |  M2  |    Space    |  M2  |  M4  | Alt  | Esc  | Ctrl |
+* `-----------------------------------------------------------------------------------'
+
+* M2 Navigation & Number Blocks
+*  very easy to get used to & intuituve placement
+* ,-----------------------------------------------------------------------------------.
+* |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |   7  |   8  |   9  |      | Ins  |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* |  Tab | Home |  Lft | Down | Right| End  |   .  |   4  |   5  |   6  |   ,  | Enter|
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift|      |  Tab |      | Enter|      |   0  |   1  |   2  |   3  |   ;  |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI  | Alt  |  M3  |  M2  |    Space    |  M2  |  M3  | Alt  | Esc  | Ctrl |
+* `-----------------------------------------------------------------------------------'
+
+* M4 Function & Media Keys
+* ,-----------------------------------------------------------------------------------.
+* |      |      | Print|Scroll|Pause |      |      |  F7  |  F8  |  F9  |  F12 |      |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* |      |      | Mute | Vol- | Vol+ |      |   ³  |  F4  |  F5  |  F6  |  F11 |      |
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift|      | Prev | Play | Next |      |   ²  |  F1  |  F2  |  F3  |  F10 |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI  | Alt  |  M4  |  M5  |    Space    |  M5  |  M4  | Alt  | Esc  | Ctrl |
+* `-----------------------------------------------------------------------------------'
+
+
+
+Switched layers for one handed access:
+
+* M3 Switched Navigation & Number Blocks for one handed use
+*  accessed by sliding from M2 to M3 with thumb
+* ,-----------------------------------------------------------------------------------.
+* | Ins  |      |  7   |  8   |  9   |      | PgUp | Bksp |  Up  |  DEL | PgDn |      |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* |  Tab |  .   |  4   |  5   |  6   |   ,  | Home | Left | Down | Right| End  | Enter|
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift|  0   |  1   |  2   |  3   |   ;  |      | Tab  |  Ins | Enter|      |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI  | Alt  |  M3  |      |    Space    |      |  M3  | Alt  | Esc  | Ctrl |
+* `-----------------------------------------------------------------------------------'
+
+* M5 Switched Function & Media Keys|
+*  accessed by sliding from M4 to M5 with thumb
+* ,-----------------------------------------------------------------------------------.
+* |      |      |  F7  |  F8  |  F9  |  F12 |      | Print|Scroll| Pause|      |      |
+* |------+------+------+------+------+-------------+------+------+------+------+------|
+* |      |  ³   |  F4  |  F5  |  F6  |  F11 |      | Mute | Vol- | Vol+ |      |      |
+* |------+------+------+------+------+------|------+------+------+------+------+------|
+* | Shift|  ²   |  F1  |  F2  |  F3  |  F10 |      | Prev | Play | Next |      |Shift |
+* |------+------+------+------+------+------+------+------+------+------+------+------|
+* | Ctrl | GUI  | Alt  |      |  M5  |    Space    |  M5  |      | Alt  | Esc  | Ctrl |
+* `-----------------------------------------------------------------------------------'
\ No newline at end of file