Move work from pinky fingers to thumbs and index fingers (#1749)

* phreed keymap added
This keymap moves many pinky keys to the center

* set to do what I want but LT() does not return to previous layer

* get overlays working

* get overlays working

* fix the readme

* fix the readme

* swapped the shift

* swapped the shift

* propagate mods

* clear special char on readme

5 files changed, 166 insertions, 0 deletions

diff --git a/keyboards/planck/keymaps/phreed/Makefile b/keyboards/planck/keymaps/phreed/Makefile
new file mode 100644
index 000000000..457a3d01d
--- /dev/null
+++ b/keyboards/planck/keymaps/phreed/Makefile
@@ -0,0 +1,3 @@
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif
diff --git a/keyboards/planck/keymaps/phreed/config.h b/keyboards/planck/keymaps/phreed/config.h
new file mode 100644
index 000000000..b406e2fed
--- /dev/null
+++ b/keyboards/planck/keymaps/phreed/config.h
@@ -0,0 +1,42 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PLANCK_SOUND)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(COLEMAK_SOUND), \
+                                  SONG(DVORAK_SOUND) \
+                                }
+#endif
+
+#define MUSIC_MASK (keycode != KC_NO)
+
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+                                
+#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+//#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 2
+
+#endif
\ No newline at end of file
diff --git a/keyboards/planck/keymaps/phreed/keymap.c b/keyboards/planck/keymaps/phreed/keymap.c
new file mode 100644
index 000000000..ff2205c10
--- /dev/null
+++ b/keyboards/planck/keymaps/phreed/keymap.c
@@ -0,0 +1,80 @@
+/* Copyright 2015-2017 Jack Humbert
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "planck.h"
+#include "action_layer.h"
+
+extern keymap_config_t keymap_config;
+
+enum planck_layers {
+  _QWERT__Y = 0,
+  _NP = 1, // Number Pad
+  _SC = 2, // Special Characters
+  _CD = 3, // Command Keys
+  _FN = 4, // Function Key
+  _PLOVER = 5 // Stenography
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[_QWERT__Y] = {
+  {KC_Q,    KC_W,    KC_E,    KC_R,         KC_T,   MEH_T(KC_ESC),  GUI_T(KC_BSLS),   KC_Y,         KC_U,    KC_I,    KC_O,     KC_P},
+  {KC_A,    KC_S,    KC_D,    LT(_NP,KC_F), KC_G,   ALT_T(KC_TAB),  ALT_T(KC_QUOT),   KC_H, LT(_FN,KC_J),    KC_K,    KC_L,  KC_SCLN},
+  {KC_Z,    KC_X,    KC_C,    LT(_SC,KC_V), KC_B,   KC_LBRC,               KC_RBRC,   KC_N, LT(_CD,KC_M), KC_COMM,  KC_DOT,  KC_SLSH},
+  {KC_LEFT, KC_DOWN, KC_BSPC, KC_ENT,       KC_LSPO,CTL_T(KC_MINS),  CTL_T(KC_EQL),KC_RSPC,       KC_SPC,  KC_DEL,   KC_UP,  KC_RGHT}
+},
+
+[_NP] = {
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LABK, KC_RABK, KC_7,    KC_8,    KC_9,    KC_DOT},
+  {XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX, KC_LALT, KC_PPLS, KC_PMNS, KC_4,    KC_5,    KC_6,    KC_0},
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PAST, KC_PSLS, KC_1,    KC_2,    KC_3,    KC_EQL},
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LSFT, KC_LCTL, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
+},
+
+[_SC] = {
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_AMPR, KC_ASTR, KC_TILD, XXXXXXX },
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LALT, XXXXXXX, XXXXXXX, KC_DLR,  KC_PERC, KC_CIRC, KC_GRV},
+  {XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_EXLM, KC_AT,   KC_HASH, XXXXXXX},
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LSFT, KC_LCTL, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
+},
+
+[_FN] = {
+  {KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_F6,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
+  {KC_F7,  KC_F8,  KC_F9,  KC_F10, KC_F11, KC_F12, KC_LALT, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX},
+  {KC_F13, KC_F14, KC_F15, KC_F16, KC_F17, KC_F18, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
+  {KC_F19, KC_F20, KC_F21, KC_F22, KC_F23, KC_F24, KC_LCTL, KC_LSFT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
+},
+
+[_CD] = {
+  {KC_HOME, KC_END,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
+  {KC_PGUP, KC_DEL,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LALT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX},
+  {KC_PGDN, KC_INS,  XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX},
+  {XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LCTL, KC_LSFT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
+},
+
+[_PLOVER] = {
+  {KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1,    KC_1   },
+  {XXXXXXX, KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC},
+  {XXXXXXX, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+  {XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX}
+}
+
+};
+
+#ifdef AUDIO_ENABLE
+  float plover_song[][2]     = SONG(PLOVER_SOUND);
+  float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
+#endif
diff --git a/keyboards/planck/keymaps/phreed/readme.md b/keyboards/planck/keymaps/phreed/readme.md
new file mode 100644
index 000000000..9080222e2
--- /dev/null
+++ b/keyboards/planck/keymaps/phreed/readme.md
@@ -0,0 +1,38 @@
+# The Phreed Planck Layout
+
+
+|  Q  |  W  |  E  |  R  |  T  | ESC |           | \  |  Y  |  U  |  I  |  O  |  P  |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+|     |     |     |     |     | meh |    MOD    | gui |     |     |     |     |     |
+| f1  | f2  | f3  | f4  | f5  | f6  |<fn]  [num>|  <  |  >  |  7  |  8  |  9  |  .  |
+|home | end |     |     |     |     |<cmd][spec>|     |     |  &  |  *  |  ~  |     |
+
+|  A  |  S  |  D  |  F  |  G  | Tab |           | ' " |  H  |  J  |  K  |  L  | ; : |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+|     |     |     | num |     | alt |    MOD    | alt |     | fn  |     |     |     |
+| f7  | f8  | f9  | f10 | f11 | f12 |<fn]  [num>|  +  |  -  |  4  |  5  |  6  |  0  |
+|pg up| del |     |     |     |     |<cmd][spec>|     |     |  $  |  %  |  ^  |  `  |
+
+|  Z  |  X  |  C  |  V  |  B  | [ { |           | ] } |  N  |  M  | , < | . > | / ? |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+|     |     |     |spec |     |     |    MOD    |     |     | cmd |     |     |     |
+| f13 | f14 | f15 | f16 | f17 | f18 |<fn]  [num>|  *  |  /  |  1  |  2  |  3  |  =  |
+|pg dn| ins |     |     |     |     |<cmd][spec>|     |     |  !  |  @  |  #  |     |
+
+| <-- | dwn | <__ |enter|  (  | - _ |           | = + |  )  | spc | __< | up  | --> |
+|-----|-----|-----|-----|-----|-----|:---------:|-----|-----|-----|-----|-----|-----|
+|     |     |     |     |shift| ctl |    MOD    | ctl |shift|     |     |     |     |
+| f19 | f20 | f21 | f22 | f23 | f24 |<fn]  [num>|     |     |     |     |     |     |
+|pg dn| ins |     |     |     |     |<cmd][spec>|     |     |     |     |     |     |
+
+
+Make example for this keyboard (after setting up your build environment):
+
+    make planck-rev3-phreed
+
+To flash the keyboard
+
+    make planck-rev3-phreed-dfu
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the
+[make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
diff --git a/keyboards/planck/keymaps/phreed/rules.mk b/keyboards/planck/keymaps/phreed/rules.mk
new file mode 100644
index 000000000..457a3d01d
--- /dev/null
+++ b/keyboards/planck/keymaps/phreed/rules.mk
@@ -0,0 +1,3 @@
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif