layout(preonic): blake-newman's layout (#2483)

* layout(preonic): blake-newman's layout

- Add keymap
  - Add Number Pad layout
  - Reconfigure other layouts to my opinionated style
- Add `readme.md` with layout information

* layout(preonic): blake-newman's layout

- Move enter to `raise + space` / `lower + space`
- Replace `enter` to `right shift`
- Explicitly map modifier keys

docs/_summary.md

@@ -3,9 +3,16 @@
   * [Install Build Tools](getting_started_build_tools.md)
     * Alternative: [Vagrant Guide](getting_started_vagrant.md)
   * [Build/Compile Instructions](getting_started_make_guide.md)
-  * [Flashing Instructions](flashing.md)
+  * [Flashing Firmware](flashing.md)
   * [Contributing to QMK](contributing.md)
   * [How to Use Github](getting_started_github.md)
+  * [Getting Help](getting_started_getting_help.md)
+
+* [Complete Newbs Guide](newbs.md)
+  * [Getting Started](newbs_getting_started.md)
+  * [Building Your First Firmware](newbs_building_firmware.md)
+  * [Flashing Firmware](newbs_flashing.md)
+  * [Testing and Debugging](newbs_testing_debugging.md)
 
 * [FAQ](faq.md)
   * [General FAQ](faq_general.md)
@@ -25,6 +32,7 @@
   * [Auto Shift](feature_auto_shift.md)
   * [Backlight](feature_backlight.md)
   * [Bootmagic](feature_bootmagic.md)
+  * [Command](feature_command.md)
   * [Dynamic Macros](feature_dynamic_macros.md)
   * [Grave Escape](feature_grave_esc.md)
   * [Key Lock](feature_key_lock.md)
@@ -37,6 +45,7 @@
   * [RGB Lighting](feature_rgblight.md)
   * [Space Cadet](feature_space_cadet.md)
   * [Stenography](feature_stenography.md)
+  * [Swap Hands](feature_swap_hands.md)
   * [Tap Dance](feature_tap_dance.md)
   * [Terminal](feature_terminal.md)
   * [Thermal Printer](feature_thermal_printer.md)

docs/eclipse.md

@@ -1,6 +1,6 @@
 # Setting up Eclipse for QMK Development
 
-[Eclipse](https://en.wikipedia.org/wiki/Eclipse_(software)) is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages.
+[Eclipse][1] is an open-source [Integrated Development Environment](https://en.wikipedia.org/wiki/Integrated_development_environment) (IDE) widely used for Java development, but with an extensible plugin system that allows to customize it for other languages and usages.
 
 Using an IDE such as Eclipse provides many advantages over a plain text editor, such as:
 * intelligent code completion
@@ -17,7 +17,7 @@ Note that this set-up has been tested on Ubuntu 16.04 only for the moment.
 
 # Prerequisites
 ## Build Environment
-Before starting, you must have followed the [Getting Started](home.md#getting-started) section corresponding to your system. In particular, you must have been able to build the firmware with [the `make` command](../#the-make-command).
+Before starting, you must have followed the [Getting Started](README.md#getting-started) section corresponding to your system. In particular, you must have been able to build the firmware with [the `make` command](../#the-make-command).
 
 ## Java
 Eclipse is a Java application, so you will need to install Java 8 or more recent to be able to run it. You may choose between the JRE or the JDK, the latter being useful if you intend to do Java development.
@@ -84,3 +84,5 @@ We will now configure a make target that cleans the project and builds the keyma
 7. (Optional) Toggle the <kbd>Hide Empty Folders</kbd> icon button above the targets tree to only show your build target.
 8. Double-click the build target you created to trigger a build.
 9. Select the <kbd>Console</kbd> view at the bottom to view the running build.
+
+  [1]: https://en.wikipedia.org/wiki/Eclipse_(software)

docs/faq_keymap.md

@@ -14,6 +14,15 @@ There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JI
 <!-- Source for this image: http://www.keyboard-layout-editor.com/#/gists/9ce023dc6caadc0cf11c88c782350a8c -->
 ![Keyboard Layout Image](https://i.imgur.com/45m4mRf.png)
 
+## Some Of My Keys Are Swapped Or Not Working
+
+QMK has two features, Bootmagic and Command, which allow you to change the behavior of your keyboard on the fly. This includes, but is not limited to, swapping Ctrl/Caps, disabling Gui, swapping Alt/Gui, swapping Backspace/Backslash, disabling all keys, and other behavioral modifications. 
+
+As a quick fix try holding down `Space`+`Backspace` while you plug in your keyboard. This will reset the stored settings on your keyboard, returning those keys to normal operation. If that doesn't work look here:
+
+* [Bootmagic](feature_bootmagic.md)
+* [Command](feature_command.md) 
+
 ## The Menu Key Isn't Working
 
 The key found on most modern keyboards that is located between `KC_RGUI` and `KC_RCTL` is actually called `KC_APP`. This is because when that key was invented there was already a key named `MENU` in the relevant standards, so MS chose to call that the `APP` key.
@@ -22,13 +31,13 @@ The key found on most modern keyboards that is located between `KC_RGUI` and `KC
 Use keycode for Print Screen(`KC_PSCREEN` or `KC_PSCR`) instead of `KC_SYSREQ`. Key combination of 'Alt + Print Screen' is recognized as 'System request'.
 
 See [issue #168](https://github.com/tmk/tmk_keyboard/issues/168) and
-- http://en.wikipedia.org/wiki/Magic_SysRq_key
+* http://en.wikipedia.org/wiki/Magic_SysRq_key
-- http://en.wikipedia.org/wiki/System_request
+* http://en.wikipedia.org/wiki/System_request
 
 ## Power Key Doesn't Work
 Use `KC_PWR` instead of `KC_POWER` or vice versa.
-- `KC_PWR` works with Windows and Linux, not with OSX.
+* `KC_PWR` works with Windows and Linux, not with OSX.
-- `KC_POWER` works with OSX and Linux, not with Windows.
+* `KC_POWER` works with OSX and Linux, not with Windows.
 
 More info: http://geekhack.org/index.php?topic=14290.msg1327264#msg1327264
 
@@ -40,9 +49,9 @@ https://github.com/tmk/tmk_keyboard/issues/67
 Modifier keys or layers can be stuck unless layer switching is configured properly.
 For Modifier keys and layer actions you have to place `KC_TRANS` on same position of destination layer to  unregister the modifier key or return to previous layer on release event.
 
-- https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching
+* https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#31-momentary-switching
-- http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
+* http://geekhack.org/index.php?topic=57008.msg1492604#msg1492604
-- https://github.com/tmk/tmk_keyboard/issues/248
+* https://github.com/tmk/tmk_keyboard/issues/248
 
 
 ## Mechanical Lock Switch Support
@@ -66,17 +75,17 @@ See this post for example **MACRO** code.
 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p195620
 
 On **Windows** you can use `AltGr` key or **Alt code**.
-- http://en.wikipedia.org/wiki/AltGr_key
+* http://en.wikipedia.org/wiki/AltGr_key
-- http://en.wikipedia.org/wiki/Alt_code
+* http://en.wikipedia.org/wiki/Alt_code
 
 On **Mac** OS defines `Option` key combinations.
-- http://en.wikipedia.org/wiki/Option_key#Alternative_keyboard_input
+* http://en.wikipedia.org/wiki/Option_key#Alternative_keyboard_input
 
 On **Xorg** you can use `compose` key, instead.
-- http://en.wikipedia.org/wiki/Compose_key
+* http://en.wikipedia.org/wiki/Compose_key
 
 And see this for **Unicode** input.
-- http://en.wikipedia.org/wiki/Unicode_input
+* http://en.wikipedia.org/wiki/Unicode_input
 
 
 ## Apple/Mac Keyboard `Fn`

docs/feature_advanced_keycodes.md

@@ -116,7 +116,7 @@ These are the values you can use for the `mod` in `MT()` and `OSM()`:
   * MOD_HYPR
   * MOD_MEH
 
-These can also be combined like `MOD_LCTL | MOD_LSFT` e.g. `MT(MOD_LCTL | MOD_LSFT, KC_ESC)` which would activate Control and Shift when held, and send Escape when tapped. Note however, that you cannot mix right and left side modifiers.
+These can also be combined like `MOD_LCTL | MOD_LSFT` e.g. `MT(MOD_LCTL | MOD_LSFT, KC_ESC)` which would activate Control and Shift when held, and send Escape when tapped.
 
 We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
 
@@ -129,6 +129,12 @@ We've added shortcuts to make common modifier/tap (mod-tap) mappings more compac
   * `LCAG_T(kc)` - is CtrlAltGui when held and *kc* when tapped
   * `MEH_T(kc)` - is like Hyper, but not as cool -- does not include the Cmd/Win key, so just sends Alt+Ctrl+Shift.
 
+{% hint style='info' %}
+Due to the way that keycodes are structured, any modifiers specified as part of `kc`, such as `LCTL()` or `KC_LPRN`, will only activate when held instead of tapped.
+
+Additionally, if there is at least one right modifier, any other modifiers will turn into their right equivalents, so it is not possible to "mix and match" the two.
+{% endhint %}
+
 # One Shot Keys
 
 One shot keys are keys that remain active until the next key is pressed, and then are released. This allows you to type keyboard combinations without pressing more than one key at a time. These keys are usually called "Sticky keys" or "Dead keys".

docs/feature_audio.md

@@ -82,7 +82,7 @@ The pitch standard (`PITCH_STANDARD_A`) is 440.0f by default - to change this, a
 
     #define PITCH_STANDARD_A 432.0f
 
-You can completely disable Music Mode as well. This is useful, if you're pressed for space on your controller.  To disable it, add this to your `confid.h`:
+You can completely disable Music Mode as well. This is useful, if you're pressed for space on your controller.  To disable it, add this to your `config.h`:
 
     #define NO_MUSIC_MODE
 

docs/feature_bootmagic.md

@@ -1,64 +1,89 @@
-# Bootmagic
+# Bootmagic and Magic Keycodes
 
-<!-- FIXME: Describe the bootmagic feature here. -->
+There are 3 separate but related features that allow you to change the behavior of your keyboard without reflashing. While each of them have similar functionality you access that functionality in different ways depending on how your keyboard is configured.
 
-## Bootmagic Keycodes
+Bootmagic is a system for configuring your keyboard while it initializes. To trigger a Bootmagic command you hold down the bootmagic key (`KC_SPACE` on most keyboards) and one or more command keys.
 
-Shortcuts for bootmagic options. You can use these even when bootmagic is off.
+Bootmagic Keycodes allow you to access the Bootmagic functionality after your keyboard has initialized. To use Bootmagic Keycodes you assign keycodes starting with `MAGIC_`, much in the same way you define any other key.
 
-|Key                               |Aliases  |Description                         |
+Command is a feature that allows you to control different aspects of your keyboard. Command used to be called Magic. Command is typically accessed by holding Left and Right Shift at the same time, although that can be customized. While it shares some functionality with Bootmagic it also allows you to access functionality that Bootmagic does not. For more information see the (Command)[feature_command.md) documentation page.
-|----------------------------------|---------|------------------------------------|
-|`MAGIC_SWAP_CONTROL_CAPSLOCK`     |         |Swap Left Control and Caps Lock     |
-|`MAGIC_CAPSLOCK_TO_CONTROL`       |         |Treat Caps Lock as Control          |
-|`MAGIC_SWAP_LALT_LGUI`            |         |Swap Left Alt and GUI               |
-|`MAGIC_SWAP_RALT_RGUI`            |         |Swap Right Alt and GUI              |
-|`MAGIC_NO_GUI`                    |         |Disable the GUI key                 |
-|`MAGIC_SWAP_GRAVE_ESC`            |         |Swap <code>&#96;</code> and Escape  |
-|`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |         |Swap Backslash and Backspace        |
-|`MAGIC_HOST_NKRO`                 |         |Force NKRO on                       |
-|`MAGIC_SWAP_ALT_GUI`              |`AG_SWAP`|Swap Alt and GUI on both sides      |
-|`MAGIC_UNSWAP_CONTROL_CAPSLOCK`   |         |Unswap Left Control and Caps Lock   |
-|`MAGIC_UNCAPSLOCK_TO_CONTROL`     |         |Stop treating CapsLock as Control   |
-|`MAGIC_UNSWAP_LALT_LGUI`          |         |Unswap Left Alt and GUI             |
-|`MAGIC_UNSWAP_RALT_RGUI`          |         |Unswap Right Alt and GUI            |
-|`MAGIC_UNNO_GUI`                  |         |Enable the GUI key                  |
-|`MAGIC_UNSWAP_GRAVE_ESC`          |         |Unswap <code>&#96;</code> and Escape|
-|`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|         |Unswap Backslash and Backspace      |
-|`MAGIC_UNHOST_NKRO`               |         |Force NKRO off                      |
-|`MAGIC_UNSWAP_ALT_GUI`            |`AG_NORM`|Unswap Left Alt and GUI             |
-|`MAGIC_TOGGLE_NKRO`               |         |Turn NKRO on or off                 |
 
+## Enabling Bootmagic
 
-## Bootmagc Hotkeys
+Bootmagic is disabled by default. To use Bootmagic you need to enable it in your `rules.mk` file:
 
-Use this by holding the SPACEBAR and the documented key while
+    BOOTMAGIC_ENABLE = yes
-plugging in the USB connection. e.g. to get into bootloader mode
-hold `SPACE` and `B` while plugging in USB.
 
+## Bootmagic Hotkeys and Keycodes
 
-|Key        |Description                                                             |
+This table describes the default Hotkeys for Bootmagic and the Keycodes for Magic. These may be overriden at the Keyboard or Keymap level. Some functionality is not available in both methods.
-|-----------|------------------------------------------------------------------------|
-|`ESC`      | Skip bootmagic and saved eeprom configuration                          |
-|`B`        | Enter bootloader instead of firmware                                   |
-|`BACKSPACE`| Clear the saved settings from flash                                    |
-|`LCTRL`    | Swap `Control` and `Capslock` and save into flash                      |
-|`CAPSLOCK` | Swap `Capslock` and `Control` and save into flash                      |
-|`LALT`     | Swap Left `Alt` and `GUI` and save into flash, e.g. for OSX Opt and Cmd|
-|`RALT`     | Swap Right `Alt` and `GUI` and save into flash                         |
-|`LGUI`     | Disable GUI key - e.g. disable Windows key during gaming               |
-|`GRAVE`    | Swap &#39; and `ESC` and save into flash                               |
-|`BACKSLASH`| Swap Blackslash and Backspace and save into flash                      |
-|`N`        | Enable NKRO (N Key Roll Over)                                          |
-|`0`        | Make Layer 0 the default layer at bootup, e.g. switch to dvorak        |
-|`1`        | Make Layer 1 the default layer at bootup                               |
-|`2`        | Make Layer 2 the default layer at bootup                               |
-|`3`        | Make Layer 3 the default layer at bootup                               |
-|`4`        | Make Layer 4 the default layer at bootup                               |
-|`5`        | Make Layer 5 the default layer at bootup                               |
-|`6`        | Make Layer 6 the default layer at bootup                               |
-|`7`        | Make Layer 7 the default layer at bootup                               |
 
+To use the Hotkey hold down `BOOTMAGIC_KEY_SALT` (`KC_SPACE` by default) and the Hotkey while plugging in your keyboard. To use the Keycode assign that keycode to a layer. For example, if you hold down Space+B while plugging in most keyboards, you will enter bootloader mode.
 
+|Hotkey     |Keycode                           |Description                                             |
+|-----------|----------------------------------|--------------------------------------------------------|
+|`ESC`      |                                  |Skip bootmagic and saved eeprom configuration           |
+|`B`        |`RESET`                           |Enter bootloader instead of firmware                    |
+|`D`        |`DEBUG`                           |Enable debugging (writes messages to serial)            |
+|`X`        |                                  |Enable matrix debugging                                 |
+|`K`        |                                  |Enable keyboard debugging                               |
+|`M`        |                                  |Enable mouse debugging                                  |
+|`BACKSPACE`|                                  |Clear the saved settings from flash                     |
+|`CAPSLOCK` |`MAGIC_CAPSLOCK_TO_CONTROL`       |Treat `Capslock` as `Control`                           |
+|           |`MAGIC_UNCAPSLOCK_TO_CONTROL`     |Stop treating CapsLock as Control                       |
+|`LCTRL`    |`MAGIC_SWAP_CONTROL_CAPSLOCK`     |Swap `Control` and `Capslock`                           |
+|           |`MAGIC_UNSWAP_CONTROL_CAPSLOCK`   |Unswap Left Control and Caps Lock                       |
+|           |`MAGIC_SWAP_ALT_GUI`              |Swap Alt and GUI on both sides                          |
+|           |`MAGIC_UNSWAP_ALT_GUI`            |Unswap Left Alt and GUI                                 |
+|`LALT`     |`MAGIC_SWAP_LALT_LGUI`            |Swap Left `Alt` and `GUI`, e.g. for OSX Opt and Cmd     |
+|           |`MAGIC_UNSWAP_LALT_LGUI`          |Unswap Left Alt and GUI                                 |
+|`RALT`     |`MAGIC_SWAP_RALT_RGUI`            |Swap Right `Alt` and `GUI`                              |
+|           |`MAGIC_UNSWAP_RALT_RGUI`          |Unswap Right Alt and GUI                                |
+|`LGUI`     |`MAGIC_NO_GUI`                    |Disable GUI key - e.g. disable Windows key during gaming|
+|           |`MAGIC_UNNO_GUI`                  |Enable the GUI key                                      |
+|`GRAVE`    |`MAGIC_SWAP_GRAVE_ESC`            |Swap `\`~` and `ESC`                                    |
+|           |`MAGIC_UNSWAP_GRAVE_ESC`          |Unswap `\`~` and Escape                                 |
+|`BACKSLASH`|`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |Swap Blackslash and Backspace                           |
+|           |`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|Unswap Backslash and Backspace                          |
+|`N`        |`MAGIC_HOST_NKRO`                 |Force N-Key Rollover (NKRO) on                          |
+|           |`MAGIC_UNHOST_NKRO`               |Force NKRO off                                          |
+|           |`MAGIC_TOGGLE_NKRO`               |Toggle NKRO on or off                                   |
+|`0`        |`DF(0)`                           |Make Layer 0 the default layer at bootup                |
+|`1`        |`DF(1)`                           |Make Layer 1 the default layer at bootup                |
+|`2`        |`DF(2)`                           |Make Layer 2 the default layer at bootup                |
+|`3`        |`DF(3)`                           |Make Layer 3 the default layer at bootup                |
+|`4`        |`DF(4)`                           |Make Layer 4 the default layer at bootup                |
+|`5`        |`DF(5)`                           |Make Layer 5 the default layer at bootup                |
+|`6`        |`DF(6)`                           |Make Layer 6 the default layer at bootup                |
+|`7`        |`DF(7)`                           |Make Layer 7 the default layer at bootup                |
 
+## Bootmagic Configuration
 
+When setting up your keyboard and/or keymap there are a number of `#define`s that control the behavior of Bootmagic. To use these put them in your `config.h`, either at the keyboard or keymap level.
 
+|Define |Default|Description |
+|-------|-------|------------|
+|`BOOTMAGIC_KEY_SALT`|`KC_SPACE`|The key to hold down to trigger Bootmagic during initialization.|
+|`BOOTMAGIC_KEY_SKIP`|`KC_ESC`|The Hotkey to ignore saved eeprom configuration.|
+|`BOOTMAGIC_KEY_EEPROM_CLEAR`|`KC_BSPACE`|The hotkey to clear the saved eeprom configuration.|
+|`BOOTMAGIC_KEY_BOOTLOADER`|`KC_B`|The hotkey to enter the bootloader.|
+|`BOOTMAGIC_KEY_DEBUG_ENABLE`|`KC_D`|The hotkey to enable debug mode.|
+|`BOOTMAGIC_KEY_DEBUG_MATRIX`|`KC_X`|The hotkey to enable matrix debugging mode.|
+|`BOOTMAGIC_KEY_DEBUG_KEYBOARD`|`KC_K`|The hotkey to enable keyboard debugging mode.|
+|`BOOTMAGIC_KEY_DEBUG_MOUSE`|`KC_M`|The hotkey to enable mouse debugging mode.|
+|`BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK`|`KC_LCTRL`||
+|`BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL`|`KC_CAPSLOCK`||
+|`BOOTMAGIC_KEY_SWAP_LALT_LGUI`|`KC_LALT`||
+|`BOOTMAGIC_KEY_SWAP_RALT_RGUI`|`KC_RALT`||
+|`BOOTMAGIC_KEY_NO_GUI`|`KC_LGUI`||
+|`BOOTMAGIC_KEY_SWAP_GRAVE_ESC`|`KC_GRAVE`||
+|`BOOTMAGIC_KEY_SWAP_BACKSLASH_BACKSPACE`|`KC_BSLASH`||
+|`BOOTMAGIC_HOST_NKRO`|`KC_N`||
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_0`|`KC_0`|Hotkey to set Layer 0 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_1`|`KC_1`|Hotkey to set Layer 1 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_2`|`KC_2`|Hotkey to set Layer 2 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_3`|`KC_3`|Hotkey to set Layer 3 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_4`|`KC_4`|Hotkey to set Layer 4 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_5`|`KC_5`|Hotkey to set Layer 5 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_6`|`KC_6`|Hotkey to set Layer 6 as the default layer|
+|`BOOTMAGIC_KEY_DEFAULT_LAYER_7`|`KC_7`|Hotkey to set Layer 7 as the default layer|

docs/feature_command.md

@@ -0,0 +1,52 @@
+# Command (Formerly known as Magic)
+
+Command is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](feature_bootmagic.md). There is a lot of overlap between this functionality and the [Bootmagic Keycodes](feature_bootmagic.md). Whenever possible we encourage you to use that functionality instead of Command.
+
+## Enabling Command
+
+By default Command is disabled. You can enable it in your `rules.mk` file:
+
+    COMMAND_ENABLE = yes
+
+## Usage
+
+To use Command you hold down the key combination defined by `IS_COMMAND`. By default that combination is both shift keys. While holding the key combination press the key corresponding to the command you want.
+
+For example, to write the current QMK version to the QMK Toolbox console, you can press `Left Shift`+`Right Shift`+`V`.
+
+## Configuration
+
+The following values can be defined in `config.h` to control the behavior of Command.
+
+|Define |Default | Description |
+|-------|--------|-------------|
+|`IS_COMMAND()`                      |`(keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))`|Key combination to activate Command|
+|`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true`                                                                |Do layer switching with Function row|
+|`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true`                                                                |Do layer switching with number keys.|
+|`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false`                                                               |Do layer switching with custom keys (`MAGIC_KEY_LAYER0..9` below.)|
+|`MAGIC_KEY_HELP1`                   |`H`                                                                   |Show help.|
+|`MAGIC_KEY_HELP2`                   |`SLASH`                                                               |Show help.|
+|`MAGIC_KEY_DEBUG`                   |`D`                                                                   |Turn on debug mode.|
+|`MAGIC_KEY_DEBUG_MATRIX`            |`X`                                                                   |Turn on matrix debugging.|
+|`MAGIC_KEY_DEBUG_KBD`               |`K`                                                                   |Turn on keyboard debugging.|
+|`MAGIC_KEY_DEBUG_MOUSE`             |`M`                                                                   |Turn on mouse debugging.|
+|`MAGIC_KEY_VERSION`                 |`V`                                                                   |Write the QMK version to the console|
+|`MAGIC_KEY_STATUS`                  |`S`                                                                   |Show the current keyboard status|
+|`MAGIC_KEY_CONSOLE`                 |`C`                                                                   |Enable the Command Console|
+|`MAGIC_KEY_LAYER0_ALT1`             |`ESC`                                                                 |Alternate access to layer 0|
+|`MAGIC_KEY_LAYER0_ALT2`             |`GRAVE`                                                               |Alternate access to layer 0|
+|`MAGIC_KEY_LAYER0`                  |`0`                                                                   |Change default layer to 0|
+|`MAGIC_KEY_LAYER1`                  |`1`                                                                   |Change default layer to 1|
+|`MAGIC_KEY_LAYER2`                  |`2`                                                                   |Change default layer to 2|
+|`MAGIC_KEY_LAYER3`                  |`3`                                                                   |Change default layer to 3|
+|`MAGIC_KEY_LAYER4`                  |`4`                                                                   |Change default layer to 4|
+|`MAGIC_KEY_LAYER5`                  |`5`                                                                   |Change default layer to 5|
+|`MAGIC_KEY_LAYER6`                  |`6`                                                                   |Change default layer to 6|
+|`MAGIC_KEY_LAYER7`                  |`7`                                                                   |Change default layer to 7|
+|`MAGIC_KEY_LAYER8`                  |`8`                                                                   |Change default layer to 8|
+|`MAGIC_KEY_LAYER9`                  |`9`                                                                   |Change default layer to 9|
+|`MAGIC_KEY_BOOTLOADER`              |`PAUSE`                                                               |Exit keyboard and enter bootloader|
+|`MAGIC_KEY_LOCK`                    |`CAPS`                                                                |Lock the keyboard so nothing can be typed|
+|`MAGIC_KEY_EEPROM`                  |`E`                                                                   |Erase EEPROM settings|
+|`MAGIC_KEY_NKRO`                    |`N`                                                                   |Toggle NKRO on/off|
+|`MAGIC_KEY_SLEEP_LED`               |`Z`                                                                   |Toggle LED when computer is sleeping on/off|

docs/feature_macros.md

@@ -22,7 +22,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 		switch(keycode) {
 			case MY_CUSTOM_MACRO:
 				SEND_STRING("QMK is the best thing ever!"); // this is our macro!
-				return false; break;
+				return false;
 		}
 	}
 	return true;
@@ -56,10 +56,10 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 		switch(keycode) {
 			case MY_CUSTOM_MACRO:
 				SEND_STRING("QMK is the best thing ever!");
-				return false; break;
+				return false;
 			case MY_OTHER_MACRO:
 				SEND_STRING(SS_LCTRL("ac")); // selects all and copies
-				return false; break;
+				return false;
 		}
 	}
 	return true;

docs/feature_mouse_keys.md

@@ -5,17 +5,17 @@ Mousekeys is a feature that allows you to emulate a mouse using your keyboard. Y
 
 ## Adding Mousekeys to a Keymap
 
-There are two steps to adding Mousekeys support to your keyboard. You must enable support in the Makefile and you must map mouse actions to keys on your keyboard.
+There are two steps to adding Mousekeys support to your keyboard. You must enable support in the `rules.mk` file and you must map mouse actions to keys on your keyboard.
 
-### Adding Mousekeys Support in the `Makefile`
+### Adding Mousekeys Support in the `rules.mk`
 
-To add support for Mousekeys you simply need to add a single line to your keymap's `Makefile`:
+To add support for Mousekeys you simply need to add a single line to your keymap's `rules.mk`:
 
 ```
 MOUSEKEY_ENABLE = yes
 ```
 
-You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/Makefile
+You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/rules.mk
 
 ### Mapping Mouse Actions to Keyboard Keys
 
@@ -40,7 +40,7 @@ You can use these keycodes within your keymap to map button presses to mouse act
 |`KC_MS_ACCEL1`  |`KC_ACL1`|Set mouse acceleration to 1|
 |`KC_MS_ACCEL2`  |`KC_ACL2`|Set mouse acceleration to 2|
 
-You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46
+You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/keymap.c#L46
 
 ## Configuring the Behavior of Mousekeys
 

docs/feature_swap_hands.md

@@ -0,0 +1,31 @@
+# Swap-Hands Action
+
+The swap-hands action allows support for one-handed typing without requiring a separate layer. Set `ONEHAND_ENABLE` in the Makefile and define a `hand_swap_config` entry in your keymap. Now whenever the `ACTION_SWAP_HANDS` command key is pressed the keyboard is mirrored. For instance, to type "Hello, World" on QWERTY you would type `^Ge^s^s^w^c W^wr^sd`
+
+## Configuration
+
+The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck:
+
+```C
+const keypos_t hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = {
+  {{11, 0}, {10, 0}, {9, 0}, {8, 0}, {7, 0}, {6, 0}, {5, 0}, {4, 0}, {3, 0}, {2, 0}, {1, 0}, {0, 0}},
+  {{11, 1}, {10, 1}, {9, 1}, {8, 1}, {7, 1}, {6, 1}, {5, 1}, {4, 1}, {3, 1}, {2, 1}, {1, 1}, {0, 1}},
+  {{11, 2}, {10, 2}, {9, 2}, {8, 2}, {7, 2}, {6, 2}, {5, 2}, {4, 2}, {3, 2}, {2, 2}, {1, 2}, {0, 2}},
+  {{11, 3}, {10, 3}, {9, 3}, {8, 3}, {7, 3}, {6, 3}, {5, 3}, {4, 3}, {3, 3}, {2, 3}, {1, 3}, {0, 3}},
+};
+```
+
+Note that the array indices are reversed same as the matrix and the values are of type `keypos_t` which is `{col, row}` and all values are zero-based. In the example above, `hand_swap_config[2][4]` (third row, fifth column) would return `{7, 2}` (third row, eighth column). Yes, this is confusing.
+
+## Advanced Swap Commands
+
+|Macro | Description |
+|------|-------------|
+| `ACTION_SWAP_HANDS()` | Swaps hands when pressed, returns to normal when released (momentary). |
+| `ACTION_SWAP_HANDS_TOGGLE()` | Toggles swap on and off with every key press. |
+| `ACTION_SWAP_HANDS_TAP_TOGGLE()` | Toggles with a tap; momentary when held. |
+| `ACTION_SWAP_HANDS_TAP_KEY(key)`| Sends `key` with a tap; momentary swap when held. |
+| `ACTION_SWAP_HANDS_ON_OFF()` | Alias for `ACTION_SWAP_HANDS()` |
+| `ACTION_SWAP_HANDS_OFF_ON()` | Momentarily turns off swap. |
+| `ACTION_SWAP_HANDS_ON()` | Turns on swapping and leaves it on. |
+| `ACTION_SWAP_HANDS_OFF()` | Turn off swapping and leaves it off. Good for returning to a known state. |

docs/getting_started_getting_help.md

@@ -0,0 +1,21 @@
+# Getting Help
+
+There are a lot of resources for getting help with QMK.
+
+## Realtime Chat
+
+You can find QMK developers and users on our main [gitter chat room](https://gitter.im/qmk/qmk_firmware). We also have other rooms for more specific discussion:
+
+* [Main Firmware Chat](https://gitter.im/qmk/qmk_firmware)
+* [QMK Toolbox](https://gitter.im/qmk/qmk_toolbox)
+* [Hardware Design Discussion](https://gitter.im/qmk/qmk_hardware)
+* [Web Configurator](https://gitter.im/qmk/qmk_configurator)
+* [Compiler API](https://gitter.im/qmk/qmk_compiler_api)
+
+## OLKB Subreddit
+
+The official QMK forum is [/r/olkb](https://reddit.com/r/olkb) on [reddit.com](https://reddit.com).
+
+## Github Issues
+
+You can open an [issue on GitHub](https://github.com/qmk/qmk_firmware/issues). This is especially handy when your issue will require long-term discussion or debugging.

docs/glossary.md

@@ -4,7 +4,7 @@
 A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI.
 
 ## AVR
-A line of 8-bit MCU's produced by [Atmel](http://atmel.com). AVR was the original platform that TMK supported.
+A line of 8-bit MCU's produced by [Atmel](http://www.microchip.com/). AVR was the original platform that TMK supported.
 
 ## AZERTY
 The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard.

docs/hardware_keyboard_guidelines.md

@@ -4,7 +4,7 @@ We welcome all keyboard projects into QMK, but ask that you try to stick to a co
 
 ## Naming Your Keyboard/Project
 
-All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Your directory and your `.h` and `.c` files should have exactly the same name. All folders should follow the same format.
+All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Your directory and your `.h` and `.c` files should have exactly the same name. All folders should follow the same format. `test`, `keyboard`, and `all` are reserved by make and are not a valid name for a keyboard.
 
 ## `readme.md`
 
@@ -16,6 +16,22 @@ In an effort to keep the repo size down, we're no longer accepting images of any
 
 Any sort of hardware file (plate, case, pcb) can't be stored in qmk_firmware, but we have the [qmk.fm repo](https://github.com/qmk/qmk.fm) where such files (as well as in-depth info) can be stored and viewed on [qmk.fm](http://qmk.fm). Downloadable files are stored in `/<keyboard>/` (name follows the same format as above) which are served at `http://qmk.fm/<keyboard>/`, and pages are generated from `/_pages/<keyboard>/` which are served at the same location (.md files are generated into .html files through Jekyll). Check out the `lets_split` directory for an example.
 
+## Keyboard Defaults
+
+Given the amount of functionality that QMK exposes it's very easy to confuse new users. When putting together the default firmware for your keyboard we recommend limiting your enabled features and options to the minimal set needed to support your hardware. Recommendations for specific features follow.
+
+### Bootmagic and Command
+
+(Bootmagic)[feature_bootmagic.md) and (Command)[feature_command.md) are two related features that allow a user to control their keyboard in non-obvious ways. We recommend you think long and hard about if you're going to enable either feature, and how you will expose this functionality. Keep in mind that users who want this functionality can enable it in their personal keymaps without affecting all the novice users who may be using your keyboard as their first programmable board.
+
+By far the most common problem new users encounter is accidentally triggering Bootmagic while they're plugging in their keyboard. They're holding the keyboard by the bottom, unknowingly pressing in alt and spacebar, and then they find that these keys have been swapped on them. We recommend leaving this feature disabled by default, but if you do turn it on consider setting `BOOTMAGIC_KEY_SALT` to a key that is hard to press while plugging your keyboard in.
+
+If your keyboard does not have 2 shift keys you should provide a working default for `IS_COMMAND`, even when you have set `COMMAND_ENABLE = no`. This will give your users a default to conform to if they do enable Command.
+
+## Custom Keyboard Programming
+
+As documented on (Customizing Functionality)[custom_quantum_functions.md] you can define custom functions for your keyboard. Please keep in mind that your users may want to customize that behavior as well, and make it possible for them to do that. If you are providing a custom function, for example `process_record_kb()`, make sure that your function calls the `_user()` version of the call too. You should also take into account the return value of the `_user()` version, and only run your custom code if the user returns `true`.
+
 ## Keyboard Metadata
 
 As QMK grows so does the ecosystem surrounding QMK. To make it easier for projects in that ecosystem to tie into QMK as we make changes we are developing a metadata system to expose information about keyboards in QMK.

docs/keycodes.md

@@ -366,7 +366,7 @@ This is a reference only. Each group of keys links to the page documenting their
 |`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>`                |
 |`KC_QUESTION`           |`KC_QUES`         |`?`                |
 
-## [Switching and Toggling Layers](feature_common_shortcuts.md#switching-and-toggling-layers)
+## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers)
 
 |Key            |Description                                                                       |
 |---------------|----------------------------------------------------------------------------------|

docs/newbs.md

@@ -0,0 +1,16 @@
+# The Compelete Newbs Guide To QMK
+
+QMK is a powerful Open Source firmware for your mechanical keyboard. You can use QMK to customize your keyboard in ways both simple and powerful. People of all skill levels, from complete newbie to master programmer, have successfully used QMK to customize their keyboard. This guide will help you do the same, no matter your skill level.
+
+Not sure if your keyboard can run QMK? If it's a mechanical keyboard you built yourself chances are good it can. We support a [large number of hobbyist boards](http://qmk.fm/keyboards/), so even if your current keyboard can't run QMK you shouldn't have trouble finding one to suit your needs.
+
+## Overview
+
+There are 4 main sections to this guide:
+
+* [Getting Started](newbs_getting_started.md)
+* [Building Your First Firmware](newbs_building_firmware.md)
+* [Flashing Firmware](newbs_flashing.md)
+* [Testing and Debugging](newbs_testing_debugging.md)
+
+This guide is focused on helping someone who has never compiled software before. It makes choices and recommendations based on that viewpoint. There are alternative methods for many of these procedures, and we support most of those alternatives. If you have any doubt about how to accomplish a task you can [ask us for guidance](getting_started_getting_help.md).

docs/newbs_building_firmware.md

@@ -0,0 +1,73 @@
+# Building Your First Firmware
+
+Now that you have setup your build environment you are ready to start building custom firmware. For this section of the guide we will bounce between 3 programs- your file manager, your text editor, and your terminal window. Keep all 3 open until you are done and happy with your keyboard firmware.
+
+If you have closed and reopened your terminal window since following the first part of the guide, don't forget to `cd qmk_firmware` so that your terminal is in the correct directory.
+
+## Navigate To Your Keymaps Folder
+
+Start by navigating to the `keymaps` folder for your keyboard.
+
+{% hint style='info' %}
+If you are on macOS or Windows there are commands you can use to easily open the keymaps folder.
+
+macOS:
+
+    open keyboards/<keyboard_folder>/keymaps
+
+Windows:
+
+    start keyboards/<keyboard_folder>/keymaps
+{% endhint %}
+
+## Create a Copy Of The `default` Keymap
+
+Once you have the `keymaps` folder open you will want to create a copy of the `default` folder. We highly recommend you name your folder the same as your GitHub username, but you can use any name you want as long as it contains only lower case letters, numbers, and the underscore character.
+
+## Open `keymap.c` In Your Favorite Text Editor
+
+Open up your `keymap.c`. Inside this file you'll find the structure that controls how your keyboard behaves. At the top of `keymap.c` there may be some defines and enums that make the keymap easier to read. Farther down you'll find a line that looks like this:
+
+    const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+This line indicates the start of the list of Layers. Below that you'll find lines containing either `LAYOUT` or `KEYMAP`, and these lines indicate the start of a layer. Below that line is the list of keys that comprise a that particular layer.
+
+{% hint style='danger' %}
+When editing your keymap file be careful not to add or remove any commas. If you do you will prevent your firmware from compiling and it may not be easy to figure out where the extra, or missing, comma is.
+{% endhint %}
+
+## Customize The Layout To Your Liking
+
+How to complete this step is entirely up to you. Make the one change that's been bugging you, or completely rework everything. You can remove layers if you don't need all of them, or add layers up to a total of 32. Check the following documentation to find out what you can define here:
+
+* [Keycodes](keycodes.md)
+* [Features](features.md)
+* [FAQ](faq.md)
+
+{% hint style='info' %}
+While you get a feel for how keymaps work, keep each change small. Bigger changes make it harder to debug any problems that arise.
+{% endhint %}
+
+## Build Your Firmware
+
+When your changes to the keymap are complete you will need to build the firmware. To do so go back to your terminal window and run the build command:
+
+    make <my_keyboard>:<my_keymap>
+
+For example, if your keymap is named "xyverz" and you're building a keymap for a rev5 planck, you'll use this command:
+
+    make planck/rev5:xyverz
+
+While this compiles you will have a lot of output going to the screen informing you of what files are being compiled. It should end with output that looks similar to this:
+
+```
+Linking: .build/planck_rev5_xyverz.elf                                                              [OK]
+Creating load file for flashing: .build/planck_rev5_xyverz.hex                                      [OK]
+Copying planck_rev5_xyverz.hex to qmk_firmware folder                                               [OK]
+Checking file size of planck_rev5_xyverz.hex                                                        [OK]
+ * File size is fine - 18392/28672
+```
+
+## Flash Your Firmware
+
+Move on to [Flashing Firmware](newbs_flashing.md) to learn how to write your new firmware to your keyboard.

docs/newbs_flashing.md

@@ -0,0 +1,79 @@
+# Flashing Your Keyboard With QMK Toolbox
+
+Now that you've built a custom firmware file you'll want to flash your keyboard. 
+
+## Load The File Into QMK Toolbox
+
+Begin by opening the QMK Toolbox application. You'll want to locate the firmware file in Finder or Explorer. Your keyboard firmware may be in one of two formats- `.hex` or `.bin`. QMK tries to copy the appropriate one for your keyboard into the root `qmk_firmware` directory.
+
+{% hint style='info' %}
+If you are on Windows or macOS there are commands you can use to easily open the current firmware folder in Explorer or Finder.
+
+Windows:
+
+    start .
+
+macOS:
+
+    open .
+{% endhint %}
+
+The firmware file always follows this naming format:
+
+    <keyboard_name>_<keymap_name>.{bin,hex}
+
+For example, the `plank/rev5` with a `default` keymap will have this filename:
+
+    planck_rev5_default.hex
+
+Once you have located your firmware file drag it into the "Local file" box in QMK Toolbox, or click "Open" and navigate to where your firmware file is stored. 
+
+## Put Your Keyboard Into DFU (Bootloader) Mode
+
+In order to flash your custom firmware you have to put your keyboard into a special flashing mode. While it is in this mode you will not be able to type or otherwise use your keyboard. It is very important that you do not unplug your keyboard or otherwise interrupt the flashing process while the firmware is being written.
+
+Different keyboards have different ways to enter this special mode. If your PCB currently runs QMK or TMK and you have not been given specific instructions try the following, in order:
+
+* Hold down both shift keys and press `Pause`
+* Hold down both shift keys and press `B`
+* Unplug your keyboard, hold down the Spacebar and `B` at the same time, plug in your keyboard and wait a second before releasing the keys
+* Press the physical `RESET` button on the bottom of the PCB
+* Locate header pins on the PCB labeled `BOOT0` or `RESET`, short those together while plugging your PCB in
+
+When you are successful you will see a message similar to this in QMK Toolbox:
+
+```
+*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
+*** DFU device connected
+```
+
+## Flash Your Keyboard
+
+Click the `Flash` button in QMK Toolbox. You will see output similar to the following:
+
+```
+*** Clueboard - Clueboard 66% HotSwap disconnected -- 0xC1ED:0x2390
+*** DFU device connected
+*** Attempting to flash, please don't remove device
+>>> dfu-programmer atmega32u4 erase --force
+    Erasing flash...  Success
+    Checking memory from 0x0 to 0x6FFF...  Empty.
+>>> dfu-programmer atmega32u4 flash /Users/skully/qmk_firmware/clueboard_66_hotswap_gen1_skully.hex
+    Checking memory from 0x0 to 0x55FF...  Empty.
+    0%                            100%  Programming 0x5600 bytes...
+    [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>]  Success
+    0%                            100%  Reading 0x7000 bytes...
+    [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>]  Success
+    Validating...  Success
+    0x5600 bytes written into 0x7000 bytes memory (76.79%).
+>>> dfu-programmer atmega32u4 reset
+    
+*** DFU device disconnected
+*** Clueboard - Clueboard 66% HotSwap connected -- 0xC1ED:0x2390
+```
+
+## Test It Out!
+
+Congrats! Your custom firmware has been programmed to your keyboard!
+
+Give it a try and make sure everything works the way you want it to. We've written [Testing and Debugging](newbs_testing_debugging.md) to round out this Newbie Guide, so head over there to learn about how to troubleshoot your custom functionality.

docs/newbs_getting_started.md

@@ -0,0 +1,98 @@
+# Introduction
+
+Your computer keyboard has a processor inside of it, not unlike the one inside your computer. This processor runs software that is responsible for detecting button presses and sending reports about the state of the keyboard when they are pressed or released. QMK fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom layout you are creating the equivalent of an .exe for your keyboard.
+
+QMK tries to put a lot of power into your hands by making easy things easy, and hard things possible. You don't have to know how to program to create powerful layouts, you only have to follow a few simple syntax rules. 
+
+# Getting Started
+
+Before you can build keymaps you need to install some software and setup your build environment. This only has to be done one time no matter how many keyboards you want to compile firmware for.
+
+## Download Software
+
+### Text Editor
+
+You'll need a program that can edit and save **plain text** files. If you are on Windows you can make due with Notepad, and on Linux you can use Gedit, both of which are simple but functional text editors. On macOS you can not use TextEdit.app, it will not save plain text files. You will need to install another program such as Sublime Text.
+
+{% hint style='info' %}
+Not sure which text editor to use? Laurence Bradford wrote [a great introduction](https://learntocodewith.me/programming/basics/text-editors/) to the subject.
+{% endhint %}
+
+### QMK Toolbox
+
+QMK Toolbox is a Windows and macOS program that allows you to both program and debug your custom keyboard. You will want to install it so that you can easily flash your keyboard and receive the debugging messages that your keyboard will print.
+
+* [Newest Release](https://github.com/qmk/qmk_toolbox/releases/latest)
+* [Source Code](https://github.com/qmk/qmk_toolbox/)
+
+## Environment Setup
+
+We've tried to make QMK as easy to setup as possible. You only have to prepare your Linux or Unix environment and let QMK install the rest.
+
+{% hint style="info" %}
+If you haven't worked with the Linux/Unix command line before there are a few basic concepts and commands you should learn. These resources will teach you enough to work with QMK:
+
+* [Must Know Linux Commands](https://www.guru99.com/must-know-linux-commands.html)
+* [Some Basic Unix Commands](https://www.tjhsst.edu/~dhyatt/superap/unixcmd.html)
+{% endhint %}
+
+### Windows
+
+You will need to install msys2 and git.
+
+* Follow the installation instructions on the msys2 homepage: http://www.msys2.org
+* Close any open msys2 terminals, and open a new terminal
+* Install git by running this command: `pacman -S git`
+
+### macOS
+
+You will need to install homebrew. Follow the instructions on the homebrew homepage: https://brew.sh
+
+### Linux
+
+You will need to install git. It's extremely likely you already have it, but if not one of the following commands should install it:
+
+* Debian/Ubuntu/Devuan: `apt-get install git`
+* Fedora/Redhat/Centos: `yum install git`
+* Arch: `pacman -S git`
+
+## Download QMK
+
+Once you have setup your Linux/Unix environment you are ready to download QMK. We will do this by using git to "clone" the QMK repository. Open a Terminal or MSYS2 Console window and leave it open for the remainder of this guide. Inside that window run these two commands:
+
+    git clone https://github.com/qmk/qmk_firmware.git
+    cd qmk_firmware
+
+{% hint style='info' %}
+If you already know [how to use GitHub](getting_started_github.md) we recommend you create and clone your own fork instead. If you don't know what that means you can safely ignore this message.
+{% endhint %}
+
+## Setup QMK
+
+QMK comes with a script to help you setup the rest of what you'll need. You should run it now by typing in this command:
+
+    ./util/qmk_install.sh
+
+## Test Your Build Environment
+
+Now that your QMK build environment is setup you can build a firmware for your keyboard. Start by trying to build the default layout for your keyboard. You should be able to do that with a command in this format:
+
+    make <keyboard>:default
+
+For example, to build a firmware for a Clueboard 66% use:
+
+    make clueboard/66/rev3:default
+
+When it is done you should have a lot of output that ends similar to this:
+
+```
+Linking: .build/clueboard_66_rev2_default.elf                                                       [OK]
+Creating load file for flashing: .build/clueboard_66_rev2_default.hex                               [OK]
+Copying clueboard_66_rev2_default.hex to qmk_firmware folder                                        [OK]
+Checking file size of clueboard_66_rev2_default.hex                                                 [OK]
+ * File size is fine - 25174/28672
+```
+
+## Creating Your Layout
+
+Now you are ready to create your own personal layout. Move on to [Building Your First Firmware](newbs_building_firmware.md) for that.

docs/newbs_testing_debugging.md

@@ -0,0 +1,33 @@
+# Testing and Debugging
+
+Once you've flashed your keyboard with a custom firmware you're ready to test it out. With a little bit of luck everything will work perfectly, but if not this document will help you figure out what's wrong.
+
+## Testing
+
+Testing your keyboard is usually pretty straightforward. Press every single key and make sure it sends the keys you expect. There are even programs that will help you make sure that no key is missed.
+
+Note: These programs are not provided by or endorsed by QMK.
+
+* [Switch Hitter](https://elitekeyboards.com/switchhitter.php) (Windows Only)
+* [Keyboard Viewer](https://www.imore.com/how-use-keyboard-viewer-your-mac) (Mac Only)
+* [Keyboard Tester](http://www.keyboardtester.com) (Web Based)
+* [Keyboard Checker](http://keyboardchecker.com) (Web Based)
+
+## Debugging With QMK Toolbox
+
+[QMK Toolbox](https://github.com/qmk/qmk_toolbox) will show messages from your keyboard if you have `CONSOLE_ENABLE = yes` in your `rules.mk`. By default the output is very limited, but you can turn on debug mode to increase the amount of debug output. Use the `DEBUG` keycode in your keymap, or use the [Command](feature_command.md) feature to enable debug mode.
+
+<!-- FIXME: Describe the debugging messages here. -->
+
+## Sending Your Own Debug Messages
+
+Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file:
+
+    #include <print.h>
+
+After that you can use a few different print functions:
+
+* `print("string")`: Print a simple string.
+* `sprintf("%s string", var)`: Print a formatted string
+* `dprint("string")` Print a simple string, but only when debug mode is enabled
+* `dprintf("%s string", var)`: Print a formatted string, but only when debug mode is enabled

docs/redirects.json

@@ -16,6 +16,10 @@
                 "from": "feature_common_shortcuts.html",
                 "to": "feature_advanced_keycodes.html"
             },
+            {
+                "from": "flashing.html",
+                "to": "newbs_flashing.html"
+            },
             {
                 "from": "key_lock.html",
                 "to": "feature_key_lock.html"

docs/understanding_qmk.md

@@ -77,7 +77,7 @@ At the keyboard level we define a C macro (typically named `KEYMAP()`) which map
 
 Notice how the second block of our `KEYMAP()` macro matches the Matrix Scanning array above? This macro is what will map the matrix scanning array to keycodes. However, if you look at a 17 key numpad you'll notice that it has 3 places where the matrix could have a switch but doesn't, due to larger keys. We have populated those spaces with `KC_NO` so that our keymap definition doesn't have to.
 
-You can also use this macro to handle unusual matrix layouts, for example the [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/rev2/rev2.h). Explaining that is outside the scope of this document.
+You can also use this macro to handle unusual matrix layouts, for example the [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/rev2/rev2.h). Explaining that is outside the scope of this document.
 
 ##### Keycode Assignment
 
@@ -135,8 +135,8 @@ The `process_record()` function itself is deceptively simple, but hidden within
 * [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L128)
   * [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L140)
     * [Map this record to a keycode](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L143)
-    * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/cluecard.c#L20)
+    * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/card.c#L20)
-      * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/keymaps/default/keymap.c#L58)
+      * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/keymaps/default/keymap.c#L58)
     * [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_midi.c#L102)
     * [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_audio.c#L10)
     * [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_music.c#L69)

keyboards/crawlpad/readme.md

@@ -14,4 +14,4 @@ Make example for this keyboard (after setting up your build environment):
 
 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.
 
-For those that prefer a GUI tool, the crawlpad.json file in this repo can be used on [kbfirmware.com](http://kbfirmware.com].
+For those that prefer a GUI tool, the crawlpad.json file in this repo can be used on [kbfirmware.com](http://kbfirmware.com).

keyboards/ergodox_ez/keymaps/bepo_tm_style/readme.md

@@ -19,4 +19,4 @@ make ergodox_ez:bepo_tm_style:all
 ## Debug
 
 See https://github.com/tmk/tmk_keyboard#magic-commands for command that can help
-debug, together with the hid_listen tool (https://docs.qmk.fm/faq_debug.html).
+debug, together with the [hid_listen tool](https://docs.qmk.fm/faq_debug.html).

keyboards/ergodox_ez/keymaps/drashna/keymap.c

@@ -19,6 +19,10 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
+//enum more_custom_keycodes {
+//    KC_P00 = NEW_SAFE_RANGE
+//};
+
 
 //define layer change stuff for underglow indicator
 bool skip_leds = false;
@@ -49,20 +53,20 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *                                 `---------------------'       `---------------------'
  */
   [_QWERTY] = LAYOUT_ergodox_wrapper(
-                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    TT(_MOUS),
+                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    OSL(_MOUS),
                 KC_TAB,  _________________QWERTY_L1_________________, TG(_DIABLO),
                 KC_BSPC, _________________QWERTY_L2_________________,
-                KC_LSFT, _________________QWERTY_L3_________________, TG(_GAMEPAD),
+                KC_MLSF, _________________QWERTY_L3_________________, TG(_GAMEPAD),
        LT(_SYMB,KC_GRV), ___________ERGODOX_BOTTOM_LEFT_____________,
                 
                                             ALT_T(KC_APP),   KC_LGUI,
                                                              KC_HOME,
                                            KC_SPACE,KC_BSPC, KC_END,
                                     
-           TT(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,   KC_MINS,
+           OSL(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,   KC_MINS,
            TG(_DIABLO),  _________________QWERTY_R1_________________, KC_BSLS,
                          _________________QWERTY_R2_________________, GUI_T(KC_QUOT),
-           TG(_GAMEPAD), _________________QWERTY_R3_________________, KC_RSFT,
+           TG(_GAMEPAD), _________________QWERTY_R3_________________, KC_MRSF,
                          ___________ERGODOX_BOTTOM_RIGHT____________, TT(_SYMB),
            KC_RGUI,      CTL_T(KC_ESCAPE),
            KC_PGUP,
@@ -93,19 +97,19 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 // Otherwise, it needs KC_*
 [_COLEMAK] = LAYOUT_ergodox_wrapper(  
         // left hand
-                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    TT(_MOUS),
+                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    OSL(_MOUS),
                 KC_TAB,  _________________COLEMAK_L1________________, TG(_DIABLO),
                 KC_BSPC, _________________COLEMAK_L2________________,
-                KC_LSFT, _________________COLEMAK_L3________________, TG(_GAMEPAD),
+                KC_MLSF, _________________COLEMAK_L3________________, TG(_GAMEPAD),
        LT(_SYMB,KC_GRV), ___________ERGODOX_BOTTOM_LEFT_____________,
                                             ALT_T(KC_APP),   KC_LGUI,
                                                              KC_HOME,
                                            KC_SPACE,KC_BSPC, KC_END,
         // right hand
-           TT(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,   KC_MINS,
+           OSL(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,   KC_MINS,
            TG(_DIABLO),  _________________COLEMAK_R1________________, KC_BSLS,
                          _________________COLEMAK_R2________________, GUI_T(KC_QUOT),
-           TG(_GAMEPAD), _________________COLEMAK_R3________________, KC_RSFT,
+           TG(_GAMEPAD), _________________COLEMAK_R3________________, KC_MRSF,
                          ___________ERGODOX_BOTTOM_RIGHT____________, TT(_SYMB),
            KC_RGUI,      CTL_T(KC_ESCAPE),
            KC_PGUP,
@@ -136,19 +140,19 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 // Otherwise, it needs KC_*
 [_DVORAK] = LAYOUT_ergodox_wrapper(  
         // left hand
-                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    TT(_MOUS),
+                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    OSL(_MOUS),
                 KC_TAB,  _________________DVORAK_L1_________________, TG(_DIABLO),
                 KC_BSPC, _________________DVORAK_L2_________________,
-                KC_LSFT, _________________DVORAK_L3_________________, TG(_GAMEPAD),
+                KC_MLSF, _________________DVORAK_L3_________________, TG(_GAMEPAD),
        LT(_SYMB,KC_GRV), ___________ERGODOX_BOTTOM_LEFT_____________,
                                             ALT_T(KC_APP),   KC_LGUI,
                                                              KC_HOME,
                                            KC_SPACE,KC_BSPC, KC_END,
         // right hand
-           TT(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,   KC_BSLS,
+           OSL(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,     KC_0,   KC_BSLS,
            TG(_DIABLO),  _________________DVORAK_R1_________________, KC_SLSH,
                          _________________DVORAK_R2_________________, GUI_T(KC_MINS),
-           TG(_GAMEPAD), _________________DVORAK_R3_________________, KC_RSFT,
+           TG(_GAMEPAD), _________________DVORAK_R3_________________, KC_MRSF,
                          ___________ERGODOX_BOTTOM_RIGHT____________, TT(_SYMB),
            KC_RGUI,      CTL_T(KC_ESCAPE),
            KC_PGUP,
@@ -179,19 +183,19 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 // Otherwise, it needs KC_*
 [_WORKMAN] = LAYOUT_ergodox_wrapper(  
         // left hand
-                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    TT(_MOUS),
+                KC_EQL,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    OSL(_MOUS),
                 KC_TAB,  _________________WORKMAN_L1________________, TG(_DIABLO),
                 KC_BSPC, _________________WORKMAN_L2________________,
-                KC_LSFT, _________________WORKMAN_L3________________, TG(_GAMEPAD),
+                KC_MLSF, _________________WORKMAN_L3________________, TG(_GAMEPAD),
        LT(_SYMB,KC_GRV), ___________ERGODOX_BOTTOM_LEFT_____________,
                                             ALT_T(KC_APP),   KC_LGUI,
                                                              KC_HOME,
                                            KC_SPACE,KC_BSPC, KC_END,
         // right hand
-           TT(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
+           OSL(_MOUS),    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS,
            TG(_DIABLO),  _________________WORKMAN_R1________________, KC_BSLS,
                          _________________WORKMAN_R2________________, GUI_T(KC_QUOT),
-           TG(_GAMEPAD), _________________WORKMAN_R3________________, KC_RSFT,
+           TG(_GAMEPAD), _________________WORKMAN_R3________________, KC_MRSF,
                          ___________ERGODOX_BOTTOM_RIGHT____________, TT(_SYMB),
            KC_RGUI,      CTL_T(KC_ESCAPE),
            KC_PGUP,
@@ -202,7 +206,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                 KC_TRNS,      KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,
                 KC_TRNS,      KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,
                 KC_TRNS,      KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,      KC_TRNS,
-                OSM(MOD_LSFT),KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,
+                KC_LSFT,KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,
                 KC_TRNS,      KC_TRNS,    KC_TRNS,    KC_TRNS,    KC_TRNS,
                                                                                 KC_TRNS,      KC_TRNS,
                                                                                               KC_TRNS,
@@ -211,7 +215,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                 KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,
                 KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,
                             KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,
-                KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      OSM(MOD_RSFT),
+                KC_TRNS,    KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_RSFT,
                                           KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,      KC_TRNS,
                 KC_TRNS,    KC_TRNS,
                 KC_TRNS,
@@ -241,9 +245,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 */
   [_SYMB] = LAYOUT_ergodox(
                 EPRM,           KC_F1,      KC_F2,      KC_F3,      KC_F4,      KC_F5,      TG(_MODS),
-                VRSN,           KC_EXLM,    KC_AT,      KC_LCBR,    KC_RCBR,    KC_PIPE,    KC_WORKMAN,
+                KC_RESET,       KC_EXLM,    KC_AT,      KC_LCBR,    KC_RCBR,    KC_PIPE,    KC_WORKMAN,
                 KC_MAKE,        KC_HASH,    KC_DLR,     KC_LPRN,    KC_RPRN,    KC_GRAVE,
-                KC_RESET,       KC_PERC,    KC_CIRC,    KC_LBRACKET,KC_RBRACKET,KC_TILD,    KC_COLEMAK,
+                VRSN,           KC_PERC,    KC_CIRC,    KC_LBRACKET,KC_RBRACKET,KC_TILD,    KC_COLEMAK,
                 KC_TRNS,        KC_AMPR,    KC_ASTR,    KC_COLN,    KC_SCOLON,
                                                                   RGB_SMOD, KC_RGB_T,
                                                                   RGB_HUI,
@@ -387,12 +391,24 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 };
 
 
-
 bool process_record_keymap(uint16_t keycode, keyrecord_t *record) {
+
+  //switch (keycode) {
+  //  case KC_P00:
+  //    if (!record->event.pressed) {
+  //      register_code(KC_KP_0);
+  //      unregister_code(KC_KP_0);
+  //      register_code(KC_KP_0);
+  //      unregister_code(KC_KP_0);
+  //    }
+  //    return false;
+  //    break;
+  //}
   return true;
 }
 
 
+
 void matrix_init_keymap(void) { // Runs boot tasks for keyboard
 };
 

keyboards/ergodox_ez/keymaps/drashna/rules.mk

@@ -1,6 +1,7 @@
 TAP_DANCE_ENABLE  = yes
 SLEEP_LED_ENABLE  = no  # Breathing sleep LED during USB suspend
-COMMAND_ENABLE    = no  # Commands for debug and configuration
+COMMAND_ENABLE    = yes  # Commands for debug and configuration
 RGBLIGHT_ENABLE   = yes
 CONSOLE_ENABLE    = no
+BOOTMAGIC_ENABLE  = yes
 

keyboards/fc980c/README.md

@@ -155,8 +155,8 @@ Datasheets
 - AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
 - JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf
 - Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/
-- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/tyu/TU1252series.pdf
 - Tr(E42) for LED?: http://cj-elec.com/txUpfile/2013614923661845.pdf
+- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf
 
 
 3.3V power supply

keyboards/gonnerd/keymaps/gam3cat/config.h

@@ -0,0 +1,7 @@
+#include "../../config.h"
+//GRAVE_ESC override for CTRL+SHIFT+ESC Windows task manager shortcut.
+#define GRAVE_ESC_CTRL_OVERRIDE
+#define PREVENT_STUCK_MODIFIERS
+
+//Delay matrix scan for tap dance, reduce to activate modifier keys faster.
+//#define TAPPING_TERM 200

keyboards/gonnerd/keymaps/gam3cat/keymap.c

@@ -0,0 +1,288 @@
+#include "gonnerd.h"
+#include "version.h"
+
+enum layers {
+    _BL = 0,    // Base Layer
+    _WL,        // Workman Layer
+    _NL,        // Norman Layer
+    _DL,        // Dvorak Layer
+    _CL,        // Base Layer
+    _FL,        // Function Layer
+    _AL,        // Adjust Layer
+};
+
+enum gonnerd_keycodes {
+    DYNAMIC_MACRO_RANGE = SAFE_RANGE,
+};
+
+#include "dynamic_macro.h"
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+#define FN_CAPS LT(_FL, KC_CAPS)
+#define KC_DMR1 DYN_REC_START1
+#define KC_DMR2 DYN_REC_START2
+#define KC_DMP1 DYN_MACRO_PLAY1
+#define KC_DMP2 DYN_MACRO_PLAY2
+#define KC_DMRS DYN_REC_STOP
+
+static uint8_t current_layer;
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* _BL: Base Layer, mostly standard TKL QWERTY layout.
+    *  .-----------------------------------------------------------------------.
+    *  |Esc||||| F1| F2| F3| F4||| F5| F6| F7| F8||| F9|F10|F11|F12|PSc|SLk|Pau|
+    *  |-----------------------------------------------------------|-----------|
+    *  |  ~|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |Ins|Hom|PgU|
+    *  |-----------------------------------------------------------|-----------|
+    *  |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|Del|End|PgD|
+    *  |-----------------------------------------------------------|-----------|
+    *  |FnCaps|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |   | Up|   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |Ctrl |||||Win  |      Space                |RAlt |||||Ctrl |Lft|Dwn|Rgt|
+    *  *-----------------------------------------------------------------------*
+    */
+    [_BL] = KEYMAP_TKL( \
+        KC_ESC,           KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_PSCR, KC_SLCK, KC_PAUS, \
+        KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC, KC_INS,  KC_HOME, KC_PGUP, \
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL,  KC_END,  KC_PGDN, \
+        FN_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, XXXXXXX, KC_ENT,                             \
+        KC_LSFT, XXXXXXX, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, MO(_FL),          KC_UP,            \
+        KC_LCTL, KC_LALT, KC_LGUI,                            KC_SPC,                             KC_RGUI, KC_RALT, MO(_FL), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT \
+    ),
+
+    /* _WL: Workman Layer.
+    *  .-----------------------------------------------------------------------.
+    *  |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    *  .-----------------------------------------------------------|-----------|
+    *  |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |  Q|  D|  R|  W|  B|  J|  F|  U|  P|  ;|  [|  ]|    \|   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |      |  A|  S|  H|  T|  G|  Y|  N|  E|  O|  I|  '|        |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |        |  Z|  X|  M|  C|  V|  K|  L|  ,|  .|  /|      |   |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |||||     |                           |     |||||     |   |   |   |
+    *  *-----------------------------------------------------------------------*
+    */
+    [_WL] = KEYMAP_TKL( \
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, KC_Q   , KC_D   , KC_R   , KC_W   , KC_B   , KC_J   , KC_F   , KC_U   , KC_P   , KC_SCLN, _______, _______, _______, _______, _______, _______, \
+        _______, KC_A   , KC_S   , KC_H   , KC_T   , KC_G   , KC_Y   , KC_N   , KC_E   , KC_O   , KC_I   , _______, _______, _______,                            \
+        _______, _______, KC_Z   , KC_X   , KC_M   , KC_C   , KC_V   , KC_K   , KC_L   , KC_COMM, KC_DOT , KC_SLSH, _______, _______,          _______,          \
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______, _______, _______, _______ \
+    ),
+
+    /* _NL: Norman Layer.
+    *  .-----------------------------------------------------------------------.
+    *  |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    *  .-----------------------------------------------------------|-----------|
+    *  |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |  Q|  W|  D|  F|  K|  J|  U|  R|  L|  ;|  [|  ]|    \|   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |      |  A|  S|  E|  T|  G|  Y|  N|  I|  O|  H|  '|        |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |        |  Z|  X|  C|  V|  B|  P|  M|  ,|  .|  /|      |   |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |||||     |                           |     |||||     |   |   |   |
+    *  *-----------------------------------------------------------------------*
+    */
+    [_NL] = KEYMAP_TKL( \
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, KC_Q   , KC_W   , KC_D   , KC_F   , KC_K   , KC_J   , KC_U   , KC_R   , KC_L   , KC_SCLN, _______, _______, _______, _______, _______, _______, \
+        _______, KC_A   , KC_S   , KC_E   , KC_T   , KC_G   , KC_Y   , KC_N   , KC_I   , KC_O   , KC_H   , _______, _______, _______,                            \
+        _______, _______, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_P   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, _______, _______,          _______,          \
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______, _______, _______, _______ \
+    ),
+
+    /* _DL: Dvorak Layer.
+    *  .-----------------------------------------------------------------------.
+    *  |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    *  .-----------------------------------------------------------|-----------|
+    *  |   |   |   |   |   |   |   |   |   |   |   |  [|  ]|       |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |  '|  ,|  .|  P|  Y|  F|  G|  C|  R|  L|  /|  =|    \|   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |      |  A|  O|  E|  U|  I|  D|  H|  T|  N|  S|  -|        |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |        |  ;|  Q|  J|  K|  X|  B|  M|  W|  V|  Z|      |   |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |||||     |                           |     |||||     |   |   |   |
+    *  *-----------------------------------------------------------------------*
+    */
+    [_DL] = KEYMAP_TKL( \
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LBRC, KC_RBRC, _______, _______, _______, _______, \
+        _______, KC_QUOT, KC_COMM, KC_DOT , KC_P   , KC_Y   , KC_F   , KC_G   , KC_C   , KC_R   , KC_L   , KC_SLSH, KC_EQL , _______, _______, _______, _______, \
+        _______, KC_A   , KC_O   , KC_E   , KC_U   , KC_I   , KC_D   , KC_H   , KC_T   , KC_N   , KC_S   , KC_MINS, _______, _______,                            \
+        _______, _______, KC_SCLN, KC_Q   , KC_J   , KC_K   , KC_X   , KC_B   , KC_M   , KC_W   , KC_V   , KC_Z   , _______, _______,          _______,          \
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______, _______, _______, _______ \
+    ),
+
+    /* _CL: Colmak Layer.
+    *  .-----------------------------------------------------------------------.
+    *  |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    *  .-----------------------------------------------------------|-----------|
+    *  |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |  Q|  W|  F|  P|  G|  J|  L|  U|  Y|  ;|  [|  ]|    \|   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |      |  A|  R|  S|  T|  D|  H|  N|  E|  I|  O|  '|        |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |        |  Z|  X|  C|  V|  B|  K|  M|  ,|  .|  /|      |   |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |||||     |                           |     |||||     |   |   |   |
+    *  *-----------------------------------------------------------------------*
+    */
+    [_CL] = KEYMAP_TKL( \
+        _______,          _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \
+        _______, KC_Q   , KC_W   , KC_F   , KC_P   , KC_G   , KC_J   , KC_L   , KC_U   , KC_Y   , KC_SCLN, _______, _______, _______, _______, _______, _______, \
+        _______, KC_A   , KC_R   , KC_S   , KC_T   , KC_D   , KC_H   , KC_N   , KC_E   , KC_I   , KC_O   , _______, _______, _______,                            \
+        _______, _______, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_K   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, _______, _______,          _______,          \
+        _______, _______, _______,                            _______,                            _______, _______, _______, _______, _______, _______, _______ \
+    ),
+
+    /* _FL: Function Layer.
+    *  M0 opens Chrome
+    *  .-----------------------------------------------------------------------.
+    *  |   |||||   |   |   |   |||   |   |   |   |||   |VlM|VlD|VlU|   |   |   |
+    *  .-----------------------------------------------------------|-----------|
+    *  | M0|   |   |   |   |   |   |   |   |   |   |   |   |       |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |Fn_AL|   |   |   |   |   |   |   |   |   |   |   |   |     |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |FnCaps|   |   |   |   |   |   |Lft|Dwn|Up |Rgt|   |        |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |        |   |   |   |   |   |   |   |   |   |   |      |   |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |||||     |                           |     |||||     |WBk|   |WFw|
+    *  *-----------------------------------------------------------------------*
+    */
+    [_FL] = KEYMAP_TKL( \
+        XXXXXXX,          XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_MUTE, KC_VOLD, KC_VOLU, XXXXXXX, XXXXXXX, XXXXXXX, \
+        M(0),    XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        MO(_AL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,                            \
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______,          XXXXXXX,          \
+        XXXXXXX, XXXXXXX, KC_MENU,                            M(1),                               XXXXXXX, _______, XXXXXXX, XXXXXXX, KC_WBAK, XXXXXXX, KC_WFWD \
+    ),
+
+    /* _AL: Adjust Layer.
+    *  Default keymap, RGB Underglow, LED backlight, and Dynamic Macro settings.
+    *  .-----------------------------------------------------------------------.
+    *  |Rst|||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    *  .-----------------------------------------------------------|-----------|
+    *  |Ver|Tog|Mod|H- |H+ |S- |S+ |V- |V+ |   |BLT|BL-|BL+|       |   |MR1|MP1|
+    *  |-----------------------------------------------------------|-----------|
+    *  |Fn_AL|_BL|_WL|   |   |   |   |   |   |   |   |   |   |     | MS|MR2|MP2|
+    *  |-----------------------------------------------------------|-----------|
+    *  |FnCaps|   |   |_DL|   |   |   |   |   |   |   |   |        |           |
+    *  |-----------------------------------------------------------|-----------|
+    *  |        |   |   |_CL|   |_BL|_NL|   |   |   |   |      |   |   |   |   |
+    *  |-----------------------------------------------------------|-----------|
+    *  |     |||||     |                           |     |||||     |   |   |   |
+    *  *-----------------------------------------------------------------------*
+    */
+    [_AL] = KEYMAP_TKL( \
+        RESET,            XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, \
+        F(0),    RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI, XXXXXXX, BL_TOGG, BL_DEC,  BL_INC,  XXXXXXX, XXXXXXX, KC_DMR1, KC_DMP1, \
+        _______, DF(_BL), DF(_WL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_DMRS, KC_DMR2, KC_DMP2, \
+        _______, XXXXXXX, XXXXXXX, DF(_DL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,                            \
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, DF(_CL), XXXXXXX, DF(_BL), DF(_NL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______,          XXXXXXX,          \
+        _______, XXXXXXX, XXXXXXX,                            XXXXXXX,                            XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX \
+    ),
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch(id) {
+        case 0:
+            if (record->event.pressed) {
+                return MACRO(I(0), D(LGUI), T(R), U(LGUI), END);
+            }
+            else {
+                SEND_STRING("chrome.exe\n");
+                return false;
+            }
+        break;
+        case 1:
+            if (record->event.pressed) {
+                return MACRO(I(0), T(SPC), T(SPC), T(SPC), T(SPC), END);
+            }
+            else {
+                return false;
+            }
+        break;
+    }
+    return MACRO_NONE;
+};
+
+const uint16_t PROGMEM fn_actions[] = {
+    [0] = ACTION_FUNCTION(0),
+};
+
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch (id) {
+        case 0:
+            if (record->event.pressed) {
+                SEND_STRING ("[QMK:" QMK_KEYBOARD ":" QMK_KEYMAP ":" QMK_VERSION "]");
+            }
+        break;
+    }
+}
+
+void matrix_init_user(void) {
+    #ifdef BACKLIGHT_ENABLE
+        backlight_level(0);
+    #endif
+}
+
+// Runs constantly in the background, in a loop.
+void matrix_scan_user(void) {
+    uint8_t layer = biton32(layer_state);
+
+    if (current_layer == layer) {
+    }
+    else {
+        current_layer = layer;
+        switch (layer) {
+            case 0:
+                backlight_level(0);
+                break;
+            case 1:
+                backlight_level(1);
+                break;
+            case 2:
+                backlight_level(1);
+                break;
+            case 3:
+                backlight_level(1);
+                break;
+            case 4:
+                backlight_level(1);
+                break;
+            case 5:
+                backlight_level(2);
+                break;
+            case 6:
+                backlight_level(3);
+                break;
+            default:
+                backlight_level(0);
+                break;
+        }
+    }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    // Enable Dynamic Macros.
+    if (!process_record_dynamic_macro(keycode, record)) {
+        return false;
+    }
+    return true;
+}

keyboards/gonnerd/keymaps/gam3cat/readme.md

@@ -0,0 +1,120 @@
+# Keymap Maintainer: Gam3cat
+make gonnerd:gam3cat
+## Layout Config:
+2u backspace, 2.25u left shift/enter, 1.75u right shift.
+2x1.5u, 1x7.0u, 2x1.5u, 3x1u bottom row.
+
+    FN_CAPS = MO(_FL) when held, CAPS when tapped.
+    GRAVE_ESC + GUI = `
+    GRAVE_ESC + SHIFT = ~
+
+## Base Layer Selection:
+(Caps+TAB+(  )): (Q)WERTY, (W)orkman, (N)orman, (D)vorak, (C)olmak
+
+### Base Layer Options:
+    _BL: Base Layer, mostly standard TKL QWERTY layout.
+    .-----------------------------------------------------------------------.
+    |Esc||||| F1| F2| F3| F4||| F5| F6| F7| F8||| F9|F10|F11|F12|PSc|SLk|Pau|
+    |-----------------------------------------------------------|-----------|
+    |  ~|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |Ins|Hom|PgU|
+    |-----------------------------------------------------------|-----------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|Del|End|PgD|
+    |-----------------------------------------------------------|-----------|
+    |FnCaps|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |           |
+    |-----------------------------------------------------------|-----------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |   | Up|   |
+    |-----------------------------------------------------------|-----------|
+    |Ctrl |||||Win  |      Space                |RAlt |||||Ctrl |Lft|Dwn|Rgt|
+    *-----------------------------------------------------------------------*
+    
+    _WL: Workman Layer.
+    .-----------------------------------------------------------------------.
+    |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    .-----------------------------------------------------------|-----------|
+    |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |  Q|  D|  R|  W|  B|  J|  F|  U|  P|  ;|  [|  ]|    \|   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |      |  A|  S|  H|  T|  G|  Y|  N|  E|  O|  I|  '|        |           |
+    |-----------------------------------------------------------|-----------|
+    |        |  Z|  X|  M|  C|  V|  K|  L|  ,|  .|  /|      |   |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |||||     |                           |     |||||     |   |   |   |
+    *-----------------------------------------------------------------------*
+    
+    _NL: Norman Layer.
+    .-----------------------------------------------------------------------.
+    |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    .-----------------------------------------------------------|-----------|
+    |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |  Q|  W|  D|  F|  K|  J|  U|  R|  L|  ;|  [|  ]|    \|   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |      |  A|  S|  E|  T|  G|  Y|  N|  I|  O|  H|  '|        |           |
+    |-----------------------------------------------------------|-----------|
+    |        |  Z|  X|  C|  V|  B|  P|  M|  ,|  .|  /|      |   |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |||||     |                           |     |||||     |   |   |   |
+    *-----------------------------------------------------------------------*
+    
+    _DL: Dvorak Layer.
+    .-----------------------------------------------------------------------.
+    |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    .-----------------------------------------------------------|-----------|
+    |   |   |   |   |   |   |   |   |   |   |   |  [|  ]|       |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |  '|  ,|  .|  P|  Y|  F|  G|  C|  R|  L|  /|  =|    \|   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |      |  A|  O|  E|  U|  I|  D|  H|  T|  N|  S|  -|        |           |
+    |-----------------------------------------------------------|-----------|
+    |        |  ;|  Q|  J|  K|  X|  B|  M|  W|  V|  Z|      |   |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |||||     |                           |     |||||     |   |   |   |
+    *-----------------------------------------------------------------------*
+    
+    _CL: Colmak Layer.
+    .-----------------------------------------------------------------------.
+    |   |||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    .-----------------------------------------------------------|-----------|
+    |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |  Q|  W|  F|  P|  G|  J|  L|  U|  Y|  ;|  [|  ]|    \|   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |      |  A|  R|  S|  T|  D|  H|  N|  E|  I|  O|  '|        |           |
+    |-----------------------------------------------------------|-----------|
+    |        |  Z|  X|  C|  V|  B|  K|  M|  ,|  .|  /|      |   |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |||||     |                           |     |||||     |   |   |   |
+    *-----------------------------------------------------------------------*
+    
+    _FL: Function Layer.
+    M0 opens Chrome
+    .-----------------------------------------------------------------------.
+    |   |||||   |   |   |   |||   |   |   |   |||   |VlM|VlD|VlU|   |   |   |
+    .-----------------------------------------------------------|-----------|
+    | M0|   |   |   |   |   |   |   |   |   |   |   |   |       |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |   |   |   |   |   |   |   |   |   |   |   |   |     |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |      |   |   |   |   |   |   |Lft|Dwn|Up |Rgt|   |        |           |
+    |-----------------------------------------------------------|-----------|
+    |        |   |   |   |   |   |   |   |   |   |   |      |   |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |||||     |                           |     |||||     |WBk|   |WFw|
+    *-----------------------------------------------------------------------*
+    
+    _AL: Adjust Layer.
+    Default keymap, RGB Underglow, LED backlight, and Dynamic Macro settings.
+    .-----------------------------------------------------------------------.
+    |Rst|||||   |   |   |   |||   |   |   |   |||   |   |   |   |   |   |   |
+    .-----------------------------------------------------------|-----------|
+    |Ver|Tog|Mod|H- |H+ |S- |S+ |V- |V+ |   |BLT|BL-|BL+|       |   |MR1|MP1|
+    |-----------------------------------------------------------|-----------|
+    |Fn_AL|_BL|_WL|   |   |   |   |   |   |   |   |   |   |     | MS|MR2|MP2|
+    |-----------------------------------------------------------|-----------|
+    |FnCaps|   |   |_DL|   |   |   |   |   |   |   |   |        |           |
+    |-----------------------------------------------------------|-----------|
+    |        |   |   |_CL|   |_BL|_NL|   |   |   |   |      |   |   |   |   |
+    |-----------------------------------------------------------|-----------|
+    |     |||||     |                           |     |||||     |   |   |   |
+    *-----------------------------------------------------------------------*

keyboards/gonnerd/keymaps/gam3cat/rules.mk

@@ -1,21 +1,20 @@
 # 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)
 EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
-CONSOLE_ENABLE = no         # Console for debug(+400)
+CONSOLE_ENABLE = yes        # Console for debug(+400)
-COMMAND_ENABLE = no        	# Commands for debug and configuration
+COMMAND_ENABLE = yes        # 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 = yes       # Enable keyboard backlight functionality
 MIDI_ENABLE = no            # MIDI controls
 AUDIO_ENABLE = no           # Audio output on port C6
-UNICODE_ENABLE = yes		# Unicode
+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.
+RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
 SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
-COMBO_ENABLE = no 			# Enable key combinations
 
 ifndef QUANTUM_DIR
 	include ../../../../Makefile

keyboards/handwired/CMD60/README.md

@@ -10,7 +10,7 @@ achieve a higher level of productivity if you take the time to learn its functio
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+For the full Quantum feature list, see [the parent readme.md](/docs/README.md).
 
 ## Building
 

keyboards/handwired/fivethirteen/README.md

@@ -3,7 +3,7 @@ fivethirteen keyboard firmware
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+For the full Quantum feature list, see [the parent readme.md](/doc/README.md).
 
 ## Building
 

keyboards/handwired/gamenum/README.md

@@ -76,7 +76,7 @@ This is the code for the KC_FN1 button. Notice how we check against what key is
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+For the full Quantum feature list, see [the parent readme.md](/docs/README.md).
 
 ## Building
 

keyboards/handwired/minorca/readme.md

@@ -30,4 +30,4 @@ Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` fol
 - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)
 - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c)
 - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck)
-- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid)
+- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck)

keyboards/handwired/reddot/readme.md

@@ -3,7 +3,7 @@
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent README.md](/README.md).
+For the full Quantum feature list, see [the parent README.md](/readme.md).
 
 ## Building
 

keyboards/handwired/traveller/readme.md

@@ -14,7 +14,7 @@ You can make your own traveller  keyboard by using the openscad tools from the a
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent README.md](/README.md).
+For the full Quantum feature list, see [the parent README.md](/readme.md).
 
 ## Building
 

keyboards/jc65/v32u4/keymaps/gam3cat/config.h

@@ -0,0 +1,7 @@
+#include "../../config.h"
+//GRAVE_ESC override for CTRL+SHIFT+ESC Windows task manager shortcut.
+#define GRAVE_ESC_CTRL_OVERRIDE
+#define PREVENT_STUCK_MODIFIERS
+
+//Delay matrix scan for tap dance, reduce to activate modifier keys faster.
+//#define TAPPING_TERM 200

keyboards/jc65/v32u4/keymaps/gam3cat/keymap.c

@@ -0,0 +1,279 @@
+#include "jc65.h"
+#include "version.h"
+
+enum layers {
+    _BL = 0,    // Base Layer
+    _WL,        // Workman Layer
+    _NL,        // Norman Layer
+    _DL,        // Dvorak Layer
+    _CL,        // Base Layer
+    _FL,        // Function Layer
+    _AL,        // Adjust Layer
+};
+
+enum jc65_keycodes {
+    DYNAMIC_MACRO_RANGE = SAFE_RANGE,
+};
+
+#include "dynamic_macro.h"
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+#define FN_CAPS LT(_FL, KC_CAPS)
+#define KC_DMR1 DYN_REC_START1
+#define KC_DMR2 DYN_REC_START2
+#define KC_DMP1 DYN_MACRO_PLAY1
+#define KC_DMP2 DYN_MACRO_PLAY2
+#define KC_DMRS DYN_REC_STOP
+
+static uint8_t current_layer;
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* _BL: Base Layer, mostly standard 65% QWERTY layout.
+    *  .---------------------------------------------------------------.
+    *  |GrE|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |Ins|
+    *  |---------------------------------------------------------------|
+    *  |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|Del|
+    *  |---------------------------------------------------------------|
+    *  |FnCaps|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |PgU|
+    *  |---------------------------------------------------------------|
+    *  |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Up |PgD|
+    *  |---------------------------------------------------------------|
+    *  |Ctrl|Gui |Alt |      Space             |RAlt |Ctrl |Lft|Dwn|Rgt|
+    *  *---------------------------------------------------------------*
+    */
+    [_BL] = KEYMAP(
+        KC_GESC, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  XXXXXXX, KC_BSPC, KC_INS,
+        KC_TAB,           KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS, KC_DEL,
+        FN_CAPS,          KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,           KC_PGUP,
+        KC_LSFT, XXXXXXX, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT, KC_UP,   KC_PGDN,
+        KC_LCTL, KC_LGUI,          KC_LALT, KC_SPC,           KC_SPC,           KC_SPC,           KC_RALT, KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+
+    /* _WL: Workman Layer.
+    *  .---------------------------------------------------------------.
+    *  |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |
+    *  |---------------------------------------------------------------|
+    *  |     |  Q|  D|  R|  W|  B|  J|  F|  U|  P|  ;|  [|  ]|    \|   |
+    *  |---------------------------------------------------------------|
+    *  |      |  A|  S|  H|  T|  G|  Y|  N|  E|  O|  I|  '|        |   |
+    *  |---------------------------------------------------------------|
+    *  |        |  Z|  X|  M|  C|  V|  K|  L|  ,|  .|  /|      |   |   |
+    *  |---------------------------------------------------------------|
+    *  |    |    |    |                        |     |     |   |   |   |
+    *  *---------------------------------------------------------------*
+    */
+    [_WL] = KEYMAP(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,          KC_Q   , KC_D   , KC_R   , KC_W   , KC_B   , KC_J   , KC_F   , KC_U   , KC_P   , KC_SCLN, _______, _______, _______, _______,
+        _______,          KC_A   , KC_S   , KC_H   , KC_T   , KC_G   , KC_Y   , KC_N   , KC_E   , KC_O   , KC_I   , _______, _______,          _______,
+        _______, _______, KC_Z   , KC_X   , KC_M   , KC_C   , KC_V   , KC_K   , KC_L   , KC_COMM, KC_DOT , KC_SLSH,          _______, _______, _______,
+        _______, _______,          _______, _______,          _______,          _______,          _______, _______, _______, _______, _______, _______
+    ),
+
+    /* _NL: Norman Layer.
+    *  .---------------------------------------------------------------.
+    *  |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |
+    *  |---------------------------------------------------------------|
+    *  |     |  Q|  W|  D|  F|  K|  J|  U|  R|  L|  ;|  [|  ]|    \|   |
+    *  |---------------------------------------------------------------|
+    *  |      |  A|  S|  E|  T|  G|  Y|  N|  I|  O|  H|  '|        |   |
+    *  |---------------------------------------------------------------|
+    *  |        |  Z|  X|  C|  V|  B|  P|  M|  ,|  .|  /|      |   |   |
+    *  |---------------------------------------------------------------|
+    *  |    |    |    |                        |     |     |   |   |   |
+    *  *---------------------------------------------------------------*
+    */
+    [_NL] = KEYMAP(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,          KC_Q   , KC_W   , KC_D   , KC_F   , KC_K   , KC_J   , KC_U   , KC_R   , KC_L   , KC_SCLN, _______, _______, _______, _______,
+        _______,          KC_A   , KC_S   , KC_E   , KC_T   , KC_G   , KC_Y   , KC_N   , KC_I   , KC_O   , KC_H   , _______, _______,          _______,
+        _______, _______, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_P   , KC_M   , KC_COMM, KC_DOT , KC_SLSH,          _______, _______, _______,
+        _______, _______,          _______, _______,          _______,          _______,          _______, _______, _______, _______, _______, _______
+    ),
+
+    /* _DL: Dvorak Layer.
+    *  .---------------------------------------------------------------.
+    *  |   |   |   |   |   |   |   |   |   |   |   |  [|  ]|       |   |
+    *  |---------------------------------------------------------------|
+    *  |     |  '|  ,|  .|  P|  Y|  F|  G|  C|  R|  L|  /|  =|    \|   |
+    *  |---------------------------------------------------------------|
+    *  |      |  A|  O|  E|  U|  I|  D|  H|  T|  N|  S|  -|        |   |
+    *  |---------------------------------------------------------------|
+    *  |        |  ;|  Q|  J|  K|  X|  B|  M|  W|  V|  Z|      |   |   |
+    *  |---------------------------------------------------------------|
+    *  |    |    |    |                        |     |     |   |   |   |
+    *  *---------------------------------------------------------------*
+    */
+    [_DL] = KEYMAP(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LBRC, KC_RBRC, _______, _______, _______,
+        _______,          KC_QUOT, KC_COMM, KC_DOT , KC_P   , KC_Y   , KC_F   , KC_G   , KC_C   , KC_R   , KC_L   , KC_SLSH, KC_EQL , _______, _______,
+        _______,          KC_A   , KC_O   , KC_E   , KC_U   , KC_I   , KC_D   , KC_H   , KC_T   , KC_N   , KC_S   , KC_MINS, _______,          _______,
+        _______, _______, KC_SCLN, KC_Q   , KC_J   , KC_K   , KC_X   , KC_B   , KC_M   , KC_W   , KC_V   , KC_Z   ,          _______, _______, _______,
+        _______, _______,          _______, _______,          _______,          _______,          _______, _______, _______, _______, _______, _______
+    ),
+
+    /* _CL: Colmak Layer.
+    *  .---------------------------------------------------------------.
+    *  |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |
+    *  |---------------------------------------------------------------|
+    *  |     |  Q|  W|  F|  P|  G|  J|  L|  U|  Y|  ;|  [|  ]|    \|   |
+    *  |---------------------------------------------------------------|
+    *  |      |  A|  R|  S|  T|  D|  H|  N|  E|  I|  O|  '|        |   |
+    *  |---------------------------------------------------------------|
+    *  |        |  Z|  X|  C|  V|  B|  K|  M|  ,|  .|  /|      |   |   |
+    *  |---------------------------------------------------------------|
+    *  |    |    |    |                        |     |     |   |   |   |
+    *  *---------------------------------------------------------------*
+    */
+    [_CL] = KEYMAP(
+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+        _______,          KC_Q   , KC_W   , KC_F   , KC_P   , KC_G   , KC_J   , KC_L   , KC_U   , KC_Y   , KC_SCLN, _______, _______, _______, _______,
+        _______,          KC_A   , KC_R   , KC_S   , KC_T   , KC_D   , KC_H   , KC_N   , KC_E   , KC_I   , KC_O   , _______, _______,          _______,
+        _______, _______, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_K   , KC_M   , KC_COMM, KC_DOT , KC_SLSH,          _______, _______, _______,
+        _______, _______,          _______, _______,          _______,          _______,          _______, _______, _______, _______, _______, _______
+    ),
+
+    /* _FL: Function Layer.
+    *  M0 opens Chrome
+    *  .---------------------------------------------------------------.
+    *  |M0 | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|SLock  |PSc|
+    *  |---------------------------------------------------------------|
+    *  |Fn_AL|   |   |   |   |   |   |   |   |   |   |   |   |     |Pau|
+    *  |---------------------------------------------------------------|
+    *  |FnCaps|   |   |   |   |   |Lft|Dwn|Up |Rgt|   |   |        |Hme|
+    *  |---------------------------------------------------------------|
+    *  |        |   |   |   |   |   |   |   |   |   |   |VlMute|VlU|End|
+    *  |---------------------------------------------------------------|
+    *  |    |    |Menu|                        |     |     |WBk|VlD|WFw|
+    *  *---------------------------------------------------------------*
+    */
+    [_FL] = KEYMAP(
+        M(0),    KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  XXXXXXX, KC_SLCK, KC_PSCR,
+        MO(_AL),          XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_PAUS,
+        _______,          XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, XXXXXXX, XXXXXXX, XXXXXXX,          KC_HOME,
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,          KC_MUTE, KC_VOLU, KC_END,
+        XXXXXXX, XXXXXXX,          KC_MENU, M(1),             M(1),             M(1),             XXXXXXX, XXXXXXX, XXXXXXX, KC_WBAK, KC_VOLD, KC_WFWD
+    ),
+
+    /* _AL: Adjust Layer.
+    *  Default keymap, RGB Underglow, LED backlight, and Dynamic Macro settings.
+    *  .---------------------------------------------------------------.
+    *  |Ver|Tog|Mod|H- |H+ |S- |S+ |V- |V+ |   |BLT|BL-|BL+|       |MP1|
+    *  |---------------------------------------------------------------|
+    *  |Fn_AL|_BL|_WL|   |   |   |   |   |   |   |   |   |   |     |MR1|
+    *  |---------------------------------------------------------------|
+    *  |FnCaps|   |   |_DL|   |   |   |   |   |   |   |   |        |MS |
+    *  |---------------------------------------------------------------|
+    *  |        |   |   |_CL|   |_BL|_NL|   |   |   |   |      |   |MR2|
+    *  |---------------------------------------------------------------|
+    *  |Rst |    |    |                        |     |     |   |   |MP2|
+    *  *---------------------------------------------------------------*
+    */
+    [_AL] = KEYMAP(
+        F(0),    RGB_TOG, RGB_MOD, RGB_HUD, RGB_HUI, RGB_SAD, RGB_SAI, RGB_VAD, RGB_VAI, XXXXXXX, BL_TOGG, BL_DEC,  BL_INC,  XXXXXXX, XXXXXXX, KC_DMP1,
+        _______,          DF(_BL), DF(_WL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_DMR1,
+        _______,          XXXXXXX, XXXXXXX, DF(_DL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,          KC_DMRS,
+        XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, DF(_CL), XXXXXXX, DF(_BL), DF(_NL), XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX,          XXXXXXX, XXXXXXX, KC_DMR2,
+        RESET,   XXXXXXX,          XXXXXXX, XXXXXXX,          XXXXXXX,          XXXXXXX,          XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, KC_DMP2
+    ),
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch(id) {
+        case 0:
+            if (record->event.pressed) {
+                return MACRO(I(0), D(LGUI), T(R), U(LGUI), END);
+            }
+            else {
+                SEND_STRING("chrome.exe https://geekhack.org/index.php?topic=86756.new;topicseen#new\n");
+                return false;
+            }
+        break;
+        case 1:
+            if (record->event.pressed) {
+                return MACRO(I(0), T(SPC), T(SPC), T(SPC), T(SPC), END);
+            }
+            else {
+                return false;
+            }
+        break;
+    }
+    return MACRO_NONE;
+};
+
+const uint16_t PROGMEM fn_actions[] = {
+    [0] = ACTION_FUNCTION(0),
+};
+
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch (id) {
+        case 0:
+            if (record->event.pressed) {
+                SEND_STRING ("[QMK:" QMK_KEYBOARD ":" QMK_KEYMAP ":" QMK_VERSION "]");
+            }
+        break;
+    }
+}
+
+void matrix_init_user(void) {
+    #ifdef BACKLIGHT_ENABLE
+        backlight_level(0);
+    #endif
+    #ifdef RGBLIGHT_ENABLE
+        rgblight_mode(1);
+        rgblight_sethsv(180,100,100);
+    #endif
+}
+
+// Runs constantly in the background, in a loop.
+void matrix_scan_user(void) {
+    uint8_t layer = biton32(layer_state);
+
+    if (current_layer == layer) {
+    }
+    else {
+        current_layer = layer;
+        switch (layer) {
+            case 0:
+                backlight_level(0);
+                rgblight_sethsv(180,100,255);
+                break;
+            case 1:
+                backlight_level(1);
+                rgblight_sethsv(180,95,240);
+                break;
+            case 2:
+                backlight_level(1);
+                rgblight_sethsv(180,90,225);
+                break;
+            case 3:
+                backlight_level(1);
+                rgblight_sethsv(180,85,210);
+                break;
+            case 4:
+                backlight_level(1);
+                rgblight_sethsv(180,80,195);
+                break;
+            case 5:
+                backlight_level(2);
+                rgblight_sethsv(230,255,255);
+                break;
+            case 6:
+                backlight_level(3);
+                rgblight_sethsv(350,255,255);
+                break;
+            default:
+                backlight_level(0);
+                rgblight_sethsv(180,100,100);
+                break;
+        }
+    }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    // Enable Dynamic Macros.
+    if (!process_record_dynamic_macro(keycode, record)) {
+        return false;
+    }
+    return true;
+}

keyboards/jc65/v32u4/keymaps/gam3cat/readme.md

@@ -0,0 +1,109 @@
+# Keymap Maintainer: Gam3cat
+make jc65/v32u4:gam3cat
+## Layout Config:
+2u backspace, 2.25u left shift/enter, 1.75u right shift.
+(2x1.5u, 1x7.0u, 2x1.5u, 3x1u), (3x1.25u, 1x6.25u, 2x1.5u, 3x1u), or
+(3x1.25u, 1x6.25u, 6x1u) bottom row.
+
+    FN_CAPS = MO(_FL) when held, CAPS when tapped.
+    GRAVE_ESC + GUI = `
+    GRAVE_ESC + SHIFT = ~
+
+## Base Layer Selection:
+(Caps+TAB+(  )): (Q)WERTY, (W)orkman, (N)orman, (D)vorak, (C)olmak
+
+### Base Layer Options:
+#### _BL: Base Layer, mostly standard 65% QWERTY layout.
+    .---------------------------------------------------------------.
+    |GrE|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |Ins|
+    |---------------------------------------------------------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|Del|
+    |---------------------------------------------------------------|
+    |FnCaps|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |PgU|
+    |---------------------------------------------------------------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Up |PgD|
+    |---------------------------------------------------------------|
+    |Ctrl|Gui |Alt |      Space             |RAlt |Ctrl |Lft|Dwn|Rgt|
+    *---------------------------------------------------------------*
+
+#### _WL: Workman Layer.
+    .---------------------------------------------------------------.
+    |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |
+    |---------------------------------------------------------------|
+    |     |  Q|  D|  R|  W|  B|  J|  F|  U|  P|  ;|  [|  ]|    \|   |
+    |---------------------------------------------------------------|
+    |      |  A|  S|  H|  T|  G|  Y|  N|  E|  O|  I|  '|        |   |
+    |---------------------------------------------------------------|
+    |        |  Z|  X|  M|  C|  V|  K|  L|  ,|  .|  /|      |   |   |
+    |---------------------------------------------------------------|
+    |    |    |    |                        |     |     |   |   |   |
+    *---------------------------------------------------------------*
+
+#### _NL: Norman Layer.
+    .---------------------------------------------------------------.
+    |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |
+    |---------------------------------------------------------------|
+    |     |  Q|  W|  D|  F|  K|  J|  U|  R|  L|  ;|  [|  ]|    \|   |
+    |---------------------------------------------------------------|
+    |      |  A|  S|  E|  T|  G|  Y|  N|  I|  O|  H|  '|        |   |
+    |---------------------------------------------------------------|
+    |        |  Z|  X|  C|  V|  B|  P|  M|  ,|  .|  /|      |   |   |
+    |---------------------------------------------------------------|
+    |    |    |    |                        |     |     |   |   |   |
+    *---------------------------------------------------------------*
+
+#### _DL: Dvorak Layer.
+    .---------------------------------------------------------------.
+    |   |   |   |   |   |   |   |   |   |   |   |  [|  ]|       |   |
+    |---------------------------------------------------------------|
+    |     |  '|  ,|  .|  P|  Y|  F|  G|  C|  R|  L|  /|  =|    \|   |
+    |---------------------------------------------------------------|
+    |      |  A|  O|  E|  U|  I|  D|  H|  T|  N|  S|  -|        |   |
+    |---------------------------------------------------------------|
+    |        |  ;|  Q|  J|  K|  X|  B|  M|  W|  V|  Z|      |   |   |
+    |---------------------------------------------------------------|
+    |    |    |    |                        |     |     |   |   |   |
+    *---------------------------------------------------------------*
+
+#### _CL: Colmak Layer.
+    .---------------------------------------------------------------.
+    |   |   |   |   |   |   |   |   |   |   |   |  -|  =|       |   |
+    |---------------------------------------------------------------|
+    |     |  Q|  W|  F|  P|  G|  J|  L|  U|  Y|  ;|  [|  ]|    \|   |
+    |---------------------------------------------------------------|
+    |      |  A|  R|  S|  T|  D|  H|  N|  E|  I|  O|  '|        |   |
+    |---------------------------------------------------------------|
+    |        |  Z|  X|  C|  V|  B|  K|  M|  ,|  .|  /|      |   |   |
+    |---------------------------------------------------------------|
+    |    |    |    |                        |     |     |   |   |   |
+    *---------------------------------------------------------------*
+
+### Function Layer: (hold Caps to access)
+    M0 opens Chrome
+#### _FL: Function Layer.
+    .---------------------------------------------------------------.
+    |M0 | F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|SLock  |PSc|
+    |---------------------------------------------------------------|
+    |Fn_AL|   |   |   |   |   |   |   |   |   |   |   |   |     |Pau|
+    |---------------------------------------------------------------|
+    |FnCaps|   |   |   |   |   |Lft|Dwn|Up |Rgt|   |   |        |Hme|
+    |---------------------------------------------------------------|
+    |        |   |   |   |   |   |   |   |   |   |   |VlMute|VlU|End|
+    |---------------------------------------------------------------|
+    |    |    |Menu|                        |     |     |WBk|VlD|WFw|
+    *---------------------------------------------------------------*
+
+### Adjust Layer: (hold Caps+TAB to access)
+    Default keymap, RGB Underglow, LED backlight, and Dynamic Macro settings.
+#### _AL: Adjust Layer.
+    .---------------------------------------------------------------.
+    |Ver|Tog|Mod|H- |H+ |S- |S+ |V- |V+ |   |BLT|BL-|BL+|       |MP1|
+    |---------------------------------------------------------------|
+    |Fn_AL|_BL|_WL|   |   |   |   |   |   |   |   |   |   |     |MR1|
+    |---------------------------------------------------------------|
+    |FnCaps|   |   |_DL|   |   |   |   |   |   |   |   |        |MS |
+    |---------------------------------------------------------------|
+    |        |   |   |_CL|   |_BL|_NL|   |   |   |   |      |   |MR2|
+    |---------------------------------------------------------------|
+    |Rst |    |    |                        |     |     |   |   |MP2|
+    *---------------------------------------------------------------*

keyboards/jc65/v32u4/keymaps/gam3cat/rules.mk

@@ -0,0 +1,6 @@
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif
+
+BACKLIGHT_ENABLE=yes
+//TAP_DANCE_ENABLE=yes

keyboards/jd40/readme.md

@@ -5,7 +5,7 @@ A compact 40% keyboard.
 
 Keyboard Maintainer: QMK Community
 Hardware Supported: JD40 PCB
-Hardware Availability: [1up](https://1upkeyboards.com/jd40-mkii-1up-keyboards-logo-pcb.html) [mechanicalkeyboards.com](https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=2452) [originative](https://originative.co/products/jd40-pcb)
+Hardware Availability: [1up](https://1upkeyboards.com/jd40-mkii-1up-keyboards-logo-pcb.html) [mechanicalkeyboards.com](https://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=2452) [originative](https://www.originativeco.com/products/jd40-pcb)
 
 Make example for this keyboard (after setting up your build environment):
 

keyboards/kbd66/keymaps/maartenwut/config.h

@@ -0,0 +1,24 @@
+/* Copyright 2018 Alex Peters
+ *
+ * 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/>.
+ */
+
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.h"
+
+// place overrides here
+
+#endif

keyboards/kbd66/keymaps/maartenwut/keymap.c

@@ -0,0 +1,69 @@
+#include "kbd66.h"
+
+#define _MA 0
+#define _GA 1
+#define _FL 2
+#define _AR 3
+#define _LE 4
+#define _LO 5
+#define _UL 6
+
+#define TRNS KC_TRNS
+#define ______ KC_NO
+#define trigger_time 400
+
+#define LSHIFT OSM(MOD_LSFT)
+#define SPACE LT(_AR, KC_SPC)
+#define CAPS LT(_LE, KC_CAPS)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+// Main Layer
+[_MA] = KEYMAP_ANSI(
+	KC_GESC,	KC_1, 		KC_2, 		KC_3, 		KC_4, 		KC_5, 		KC_6, 		KC_7, 		KC_8, 		KC_9, 		KC_0, 		KC_MINS,	KC_EQL,		KC_MPLY,	KC_BSPC,	KC_PSCR,
+	KC_TAB,		KC_Q, 		KC_W, 		KC_E, 		KC_R, 		KC_T, 		KC_Y, 		KC_U, 		KC_I,  		KC_O,  		KC_P, 		KC_LBRC,	KC_RBRC,	KC_BSLS,				KC_DEL,
+	CAPS,		KC_A, 		KC_S,   	KC_D, 		KC_F, 		KC_G, 		KC_H, 		KC_J, 		KC_K,  		KC_L,  		KC_SCLN, 	KC_QUOT,  				KC_ENT,
+	LSHIFT, 	TRNS,		KC_Z, 		KC_X,   	KC_C, 		KC_V, 		KC_B, 		KC_N, 		KC_M, 		KC_COMM, 	KC_DOT,		KC_SLSH, 	KC_RSFT,    TRNS,		KC_UP,
+	KC_LCTL, 	KC_LGUI, 	KC_LALT,							SPACE,					SPACE,								KC_RALT,	KC_RCTRL, 	MO(_FL),	KC_LEFT, 	KC_DOWN, 	KC_RGHT),
+
+//Function Layer
+[_FL] = KEYMAP_ANSI(
+	KC_GRV,		KC_F1,		KC_F2,  	KC_F3,  	KC_F4,  	KC_F5,		KC_F6,		KC_F7, 		KC_F8,		KC_F9,		KC_F10,  	KC_F11,		KC_F12,		TRNS,		RESET,		KC_PGUP,
+	TRNS, 		KC_BTN1,	KC_MS_U,  	KC_BTN2, 	TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS,		TRNS,					KC_PGDN,
+	TRNS, 		KC_MS_L,	KC_MS_D, 	KC_MS_R,	TRNS,		TG(_GA),	TRNS,		TRNS,		TRNS,		TRNS,		TRNS,		TRNS,					TRNS,
+	TRNS, 		TRNS,		TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS,		TRNS,		KC_VOLD,	KC_VOLU,	KC_MUTE,	TRNS,		TRNS,		KC_WH_U,
+	TRNS, 		TRNS, 		TRNS,								TRNS,					TRNS,								TRNS,		TRNS,		TRNS,   	KC_WH_L,	KC_WH_D, 	KC_WH_R),
+
+//Arrow keys layer (space bar)
+[_AR] = KEYMAP_ANSI(
+	KC_GRV,		KC_F1,		KC_F2,  	KC_F3,  	KC_F4,  	KC_F5,		KC_F6,		KC_F7, 		KC_F8,		KC_F9,		KC_F10,  	KC_F11,		KC_F12,		TRNS,		TRNS,		TRNS,
+	TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,					TRNS,
+	TRNS,		TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS,	  	TRNS, 		TRNS, 	 				TRNS,
+	TRNS,		TRNS,		TRNS,		TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,   	TRNS,		TRNS,
+	TRNS, 		TRNS, 		TRNS,								TRNS,					TRNS,								TRNS,		TRNS, 		M(0),		TRNS, 		TRNS, 		TRNS),
+//LED control layer (caps)
+[_LE] = KEYMAP_ANSI(
+	TRNS,		TRNS,		TRNS,  		TRNS,  		TRNS,  		TRNS,		TRNS,		TRNS, 		TRNS,		TRNS,		TRNS,  		TRNS,		TRNS,		TRNS,		TRNS,		TRNS,
+	TRNS,		BL_TOGG, 	TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,					TRNS,
+	TRNS,		BL_INC,		TRNS,   	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS, 	 				TRNS,
+	TRNS,		TRNS,		BL_DEC,		TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,   	TRNS,		TRNS,
+	TRNS, 		TRNS, 		TRNS,								TRNS,					TRNS,								TRNS,		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS),
+
+//Game layer (fn + g)
+[_GA] = KEYMAP_ANSI(
+	TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS,		TRNS,		TRNS,		TRNS,
+	TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,					TRNS,
+	KC_CAPS,	TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,  					TRNS,
+	KC_LSFT, 	TRNS,		TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,		TRNS,		TRNS,
+	TRNS, 		TRNS, 		TRNS,								KC_SPC,					KC_SPC,								TRNS,		TRNS, 		MO(_FL),	TRNS, 		TRNS, 		TRNS),
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch (id) {
+		case 0:
+			if (record->event.pressed) {
+				SEND_STRING("AdminF123!");
+			}
+			break;
+	}
+    return MACRO_NONE;
+};

keyboards/kbd66/keymaps/maartenwut/readme.md

@@ -0,0 +1,3 @@
+# Maartenwut's KBD66 layout
+
+This is Maartenwut's layout, which is really similar to Maartenwut's Tada68 layout.

keyboards/kinesis/alvicstep/readme.md

@@ -23,7 +23,7 @@ Not yet implemented:
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+For the full Quantum feature list, see [the parent readme.md](/docs/README.md).
 
 ## Building
 

keyboards/kinesis/stapelberg/readme.md

@@ -26,18 +26,18 @@ If you want to perform this customization, these parts may be helpful.
 | Reset cables                                           | 2        | Sparkfun | PRT-09140    |
 
 The board and connections are shown here
-![](images/controller_board.jpg)
+![controller board](https://i.imgur.com/2ZPMwvZ.jpg)
 
 The Teensy mounting detail can be seen here.
 I used a socket for prototyping.
-![](images/teensy_detail.jpg)
+![teensy detail](https://i.imgur.com/HrkGUjc.jpg)
 
 
 Since the proper mounting of the Teensy board places the reset button in a tight space, I added a 2-pin header to the reset and ground pins on the edge of the board.
 Shorting these two pins together will reset the board.
 I also put female to male header jumper cables on these so they could be accessed outside the enclosure.
 The exterior cables can be seen here.
-![](images/exterior_reset.jpg)
+![exterior reset](https://i.imgur.com/JNoxI40.jpg)
 
 
 ## Keymaps
@@ -52,7 +52,3 @@ To build with the default keymap, run `make default` while in the
 This keymap contains a dvorak implementation as well as media and symbol layers.
 
 Run `make dvorak` while in the `kinesis_stapelberg` working directory.
-
-![controller board](https://i.imgur.com/2ZPMwvZ.jpg)
-![exterior reset](https://i.imgur.com/JNoxI40.jpg)
-![teensy detail](https://i.imgur.com/HrkGUjc.jpg)

keyboards/kmac/readme.md

@@ -33,7 +33,7 @@ A [keymap](keymaps/winkeyless) for the winkeyless version of the PCB are also pr
 
 ### Custom keymaps
 
-To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/Keymap.html) for details on how to modify the keymap.
+To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/faq_keymap.html) for details on how to modify the keymap.
 
 To make it easy to define keymaps for the different versions of the PCB two macros are provided.
 

keyboards/knops/mini/keymaps/default/keymap.c

@@ -107,7 +107,11 @@ void set_switch_led(int ledId, bool state) {
 				PORTD |= (1<<7);
 				break;
 			case 2:
-				PORTC |= (1<<6);
+				if((PINB & (1 << 7)) != 0) {
+					PORTC |= (1<<6);
+				} else {
+					PORTC |= (1<<7);
+				}
 				break;
 			case 3:
 				PORTD |= (1<<4);
@@ -128,7 +132,11 @@ void set_switch_led(int ledId, bool state) {
 				PORTD &= ~(1<<7);
 				break;
 			case 2:
-				PORTC &= ~(1<<6);
+				if((PINB & (1 << 7)) != 0) {
+					PORTC &= ~(1<<6);
+				} else {
+					PORTC &= ~(1<<7);
+				}
 				break;
 			case 3:
 				PORTD &= ~(1<<4);
@@ -167,9 +175,12 @@ void set_layer_led(int layerId) {
 void matrix_init_user(void) {
 	led_init_ports();
 	
+	PORTB |= (1 << 7);
+	DDRB &= ~(1<<7);
 	
 	PORTD |= (1<<7);
 	PORTC |= (1<<6);
+	PORTC |= (1<<7);
 	PORTD |= (1<<4);
 	PORTE |= (1<<6);
 	PORTB |= (1<<4);
@@ -188,7 +199,9 @@ void led_init_ports() {
 	
   // led voor switch #2
 	DDRC |= (1<<6);
+	DDRC |= (1<<7);
 	PORTC &= ~(1<<6);
+	PORTC &= ~(1<<7);
 	
   // led voor switch #3
 	DDRD |= (1<<4);

keyboards/knops/mini/keymaps/knops/keymap.c

@@ -16,7 +16,11 @@ void set_led_state(int ledId, bool state) {
 				PORTD |= (1<<7);
 				break;
 			case 1:
-				PORTC |= (1<<6);
+				if((PINB & (1 << 7)) != 0) {
+					PORTC |= (1<<6);
+				} else {
+					PORTC |= (1<<7);
+				}
 				break;
 			case 2:
 				PORTD |= (1<<4);
@@ -47,7 +51,11 @@ void set_led_state(int ledId, bool state) {
 				PORTD &= ~(1<<7);
 				break;
 			case 1:
-				PORTC &= ~(1<<6);
+				if((PINB & (1 << 7)) != 0) {
+					PORTC &= ~(1<<6);
+				} else {
+					PORTC &= ~(1<<7);
+				}
 				break;
 			case 2:
 				PORTD &= ~(1<<4);
@@ -75,8 +83,12 @@ void set_led_state(int ledId, bool state) {
 }
 
 void led_init_ports() {
+	PORTB |= (1 << 7);
+	DDRB &= ~(1<<7);
+	
 	DDRD |= (1<<7);
 	DDRC |= (1<<6);
+	DDRC |= (1<<7);
 	DDRD |= (1<<4);
 	DDRE |= (1<<6);
 	DDRB |= (1<<4);
@@ -87,10 +99,16 @@ void led_init_ports() {
 	DDRB |= (1<<0);
 }
 
+void led_set_layer(int layer) {
+
+	/*KNOPS_SIMPLELED_STATES*/
+
+}
+
 void matrix_init_user(void) {
 	led_init_ports();
 	
-	led_set_layer(0);
+	led_set_layer(1);
 	
 	/*KNOPS_INIT*/
 }
@@ -112,12 +130,6 @@ void led_set_user(uint8_t usb_led) {
 
 }
 
-void led_set_layer(int layer) {
-
-	/*KNOPS_SIMPLELED_STATES*/
-
-}
-
 bool process_record_user (uint16_t keycode, keyrecord_t *record) {
   
 	/*KNOPS_PROCESS_STATE*/

keyboards/lets_split/readme.md

@@ -44,7 +44,7 @@ If everything worked correctly you will see a file:
 lets_split_rev2_YOUR_KEYMAP_NAME.hex
 ```
 
-For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md.
+For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md.
 
 ### Let's split 1.0
 If you have a first generation Let's Split you will need to use the revision 1 code. To do so, use `rev1` in all your commands instead.

keyboards/lfkeyboards/lfkpad/readme.md

@@ -3,7 +3,7 @@ bluepad keyboard firmware
 
 ## Quantum MK Firmware
 
-For the full Quantum feature list, see [the parent readme.md](/doc/readme.md).
+For the full Quantum feature list, see [the parent readme.md](/docs/README.md).
 
 ## Building
 

keyboards/m10a/keymaps/gam3cat/config.h

@@ -0,0 +1,2 @@
+#include "../../config.h"
+#define PREVENT_STUCK_MODIFIERS

keyboards/m10a/keymaps/gam3cat/keymap.c

@@ -0,0 +1,161 @@
+#include "m10a.h"
+#include "action_layer.h"
+#include "eeconfig.h"
+#include "version.h"
+
+extern keymap_config_t keymap_config;
+
+enum layers {
+    _L0 = 0,
+    _L1,
+    _L2,
+    _L3,
+    _L4,
+    _L5,
+    _L6,
+    _L7,
+    _L8,
+    _L9
+};
+
+enum m10a_keycodes {
+    DYNAMIC_MACRO_RANGE = SAFE_RANGE,
+};
+
+#include "dynamic_macro.h"
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+#define FN_ZERO LT(_L9, KC_0)
+#define KC_DMR1 DYN_REC_START1
+#define KC_DMR2 DYN_REC_START2
+#define KC_DMP1 DYN_MACRO_PLAY1
+#define KC_DMP2 DYN_MACRO_PLAY2
+#define KC_DMRS DYN_REC_STOP
+
+static uint8_t current_layer;
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /* .-----------.  .-----------.  .-----------.  .-----------.  .-----------.
+    *  |  7|  8|  9|  |  +|  -|  *|  |  ^|  &|  !|  |VLU|Ver|WFD|  |VLU|NXT|FFD|
+    *  |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    *  |  4|  5|  6|  |  /|  %|  ,|  |  D|  E|  F|  |MUT|C-W|CHR|  |MUT|STP|PLY|
+    *  |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    *  |  1|  2|  3|  |  .|  =|Ent|  |  A|  B|  C|  |VLD|CMP|WBK|  |VLD|PRV|RWD|
+    *  |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    *  |L0 |  _L9/0|  |L1 |  _L9  |  |L2 |  _L9  |  |L3 |  _L9  |  |L4 |  _L9  |
+    *  *-----------*  *-----------*  *-----------*  *-----------*  *-----------*
+    *  .-----------.  .-----------.  .-----------.  .-----------.  .-----------.
+    *  |   |   |   |  |   |   |   |  |MP1|   |MP2|  |   |   |RST|  |_L6|_L7|_L8|
+    *  |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    *  |   |   |   |  |   |   |   |  |   |MRS|   |  |   |   |   |  |_L3|_L4|_L5|
+    *  |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    *  |   |   |   |  |   |   |   |  |MR1|   |MR2|  |   |   |   |  |_L0|_L1|_L2|
+    *  |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    *  |L5 |  _L9  |  |L6 |  _L9  |  |L7 |  _L9  |  |L8 |  _L9  |  |L9 |       |
+    *  *-----------*  *-----------*  *-----------*  *-----------*  *-----------*
+    */
+    [_L0] = {{KC_7,    KC_8,    KC_9   }, {KC_4,    KC_5,    KC_6   }, {KC_1,    KC_2,    KC_3   }, {XXXXXXX, XXXXXXX, FN_ZERO}},
+    [_L1] = {{KC_PPLS, KC_PMNS, KC_PAST}, {KC_PSLS, KC_PERC, KC_COMM}, {KC_PDOT, KC_EQL,  KC_PENT}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L2] = {{KC_CIRC, KC_AMPR, KC_EXLM}, {S(KC_D), S(KC_E), S(KC_F)}, {S(KC_A), S(KC_B), S(KC_C)}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L3] = {{KC_VOLU, F(0),    KC_WFWD}, {KC_MUTE, M(1),    M(0)   }, {KC_VOLD, KC_MYCM, KC_WBAK}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L4] = {{KC_VOLU, KC_MNXT, KC_MFFD}, {KC_MUTE, KC_MSTP, KC_MPLY}, {KC_VOLD, KC_MPRV, KC_MRWD}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L5] = {{_______, _______, _______}, {_______, _______, _______}, {_______, _______, _______}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L6] = {{_______, _______, _______}, {_______, _______, _______}, {_______, _______, _______}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L7] = {{KC_DMP1, _______, KC_DMP2}, {_______, KC_DMRS, _______}, {KC_DMR1, _______, KC_DMR2}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L8] = {{_______, _______, RESET  }, {_______, _______, _______}, {_______, _______, _______}, {XXXXXXX, XXXXXXX, MO(_L9)}},
+    [_L9] = {{DF(_L6), DF(_L7), DF(_L8)}, {DF(_L3), DF(_L4), DF(_L5)}, {DF(_L0), DF(_L1), DF(_L2)}, {XXXXXXX, XXXXXXX, _______}},
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch(id) {
+        case 0:
+            if (record->event.pressed) {
+                return MACRO(I(10), D(LGUI), T(R), U(LGUI), END);
+            }
+            else {
+                SEND_STRING("chrome.exe\n");
+                return false;
+            }
+        break;
+        case 1:
+            if (record->event.pressed) {
+                return MACRO(I(10), D(LCTL), T(W), U(LCTL), END);
+            }
+        break;
+    }
+    return MACRO_NONE;
+};
+
+const uint16_t PROGMEM fn_actions[] = {
+    [0] = ACTION_FUNCTION(0),
+};
+
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
+    switch (id) {
+        case 0:
+            if (record->event.pressed) {
+                SEND_STRING ("[Keyboard: " QMK_KEYBOARD "]  --  [QMK Version: " QMK_VERSION "]  --  [Keymap: " QMK_KEYMAP "]");
+            }
+        break;
+    }
+}
+
+void matrix_init_user(void) {
+  #ifdef BACKLIGHT_ENABLE
+    backlight_level(0);
+  #endif
+}
+
+// Runs constantly in the background, in a loop.
+void matrix_scan_user(void) {
+    uint8_t layer = biton32(layer_state);
+
+    if (current_layer == layer) {
+    }
+    else {
+        current_layer = layer;
+        switch (layer) {
+            case 0:
+                backlight_level(0);
+                break;
+            case 1:
+                backlight_level(1);
+                break;
+            case 2:
+                backlight_level(2);
+                break;
+            case 3:
+                backlight_level(3);
+                break;
+            case 4:
+                backlight_level(4);
+                break;
+            case 5:
+                backlight_level(5);
+                break;
+            case 6:
+                backlight_level(6);
+                break;
+            case 7:
+                backlight_level(6);
+                break;
+            case 8:
+                backlight_level(6);
+                break;
+            case 9:
+                backlight_level(0);
+                break;
+            default:
+                backlight_level(0);
+                break;
+        }
+    }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    // Enable Dynamic Macros.
+    if (!process_record_dynamic_macro(keycode, record)) {
+        return false;
+    }
+    return true;
+}

keyboards/m10a/keymaps/gam3cat/readme.md

@@ -0,0 +1,21 @@
+# Keymap Maintainer: Gam3cat
+make m10a:gam3cat
+## Layout Config:
+    .-----------.  .-----------.  .-----------.  .-----------.  .-----------.
+    |  7|  8|  9|  |  +|  -|  *|  |  ^|  &|  !|  |VLU|Ver|WFD|  |VLU|NXT|FFD|
+    |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    |  4|  5|  6|  |  /|  %|  ,|  |  D|  E|  F|  |MUT|C-W|CHR|  |MUT|STP|PLY|
+    |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    |  1|  2|  3|  |  .|  =|Ent|  |  A|  B|  C|  |VLD|CMP|WBK|  |VLD|PRV|RWD|
+    |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    |L0 |  _L9/0|  |L1 |  _L9  |  |L2 |  _L9  |  |L3 |  _L9  |  |L4 |  _L9  |
+    *-----------*  *-----------*  *-----------*  *-----------*  *-----------*
+    .-----------.  .-----------.  .-----------.  .-----------.  .-----------.
+    |   |   |   |  |   |   |   |  |MP1|   |MP2|  |   |   |RST|  |_L6|_L7|_L8|
+    |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    |   |   |   |  |   |   |   |  |   |MRS|   |  |   |   |   |  |_L3|_L4|_L5|
+    |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    |   |   |   |  |   |   |   |  |MR1|   |MR2|  |   |   |   |  |_L0|_L1|_L2|
+    |-----------|  |-----------|  |-----------|  |-----------|  |-----------|
+    |L5 |  _L9  |  |L6 |  _L9  |  |L7 |  _L9  |  |L8 |  _L9  |  |L9 |       |
+    *-----------*  *-----------*  *-----------*  *-----------*  *-----------*

keyboards/m10a/keymaps/gam3cat/rules.mk

@@ -0,0 +1,3 @@
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif

keyboards/mitosis/readme.md

@@ -3,7 +3,7 @@ Mitosis
 
 A wireless split compact keyboard.
 
-Keyboard Maintainer: [@reversebias](https://github.com/reversebias]
+Keyboard Maintainer: [@reversebias](https://github.com/reversebias)
 Hardware Supported: Mitosis PCB
 Hardware Availability: https://www.reddit.com/r/MechanicalKeyboards/comments/66588f/wireless_split_qmk_mitosis/
 

keyboards/nyquist/keymaps/333fred/README.md

@@ -1,6 +1,6 @@
 # 333fred's Nyquist Layout
 
-This nyquist layout is based on my Ergodox Infinity Layout, which is [here](../../../ergodox/keymaps/333fred/README.md). It doesn't have all of my VS extensions, as I have my nyquist at home, not at work.
+This nyquist layout is based on my Ergodox Infinity Layout, which is [here](../../../../layouts/community/ergodox/333fred/README.md). It doesn't have all of my VS extensions, as I have my nyquist at home, not at work.
 
 ## Layers
 

keyboards/orthodox/keymaps/drashna/keymap.c

@@ -31,36 +31,35 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 // Fillers to make layering more clear
 #define _______ KC_TRNS
 #define XXXXXXX KC_NO
-#define KC_MSHF OSM(MOD_LSFT)
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 [_QWERTY] = KEYMAP_wrapper(\
   KC_ESC,  _________________QWERTY_L1_________________,                                                               _________________QWERTY_R1_________________, KC_BSPC, \
   KC_TAB,  _________________QWERTY_L2_________________,          KC_UP,   KC_DOWN,         KC_LEFT, KC_RIGHT,         _________________QWERTY_R2_________________, KC_QUOT, \
-  KC_LSFT, _________________QWERTY_L3_________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________QWERTY_R3_________________, KC_LGUI \
+  KC_MLSF, _________________QWERTY_L3_________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________QWERTY_R3_________________, KC_LGUI \
 ),
 
 [_COLEMAK] = KEYMAP_wrapper(\
   KC_ESC,  _________________COLEMAK_L1________________,                                                               _________________COLEMAK_R1________________, KC_BSPC, \
   KC_TAB,  _________________COLEMAK_L2________________,          KC_UP,   KC_DOWN,         KC_LEFT, KC_RIGHT,         _________________COLEMAK_R2________________, KC_QUOT, \
-  KC_LSFT, _________________COLEMAK_L3________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________COLEMAK_R3________________, KC_LGUI \
+  KC_MLSF, _________________COLEMAK_L3________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________COLEMAK_R3________________, KC_LGUI \
 ),
 
 [_DVORAK] = KEYMAP_wrapper(\
   KC_ESC,  _________________DVORAK_L1_________________,                                                               _________________DVORAK_R1_________________, KC_BSPC, \
   KC_TAB,  _________________DVORAK_L2_________________,          KC_UP,   KC_DOWN,         KC_LEFT, KC_RIGHT,         _________________DVORAK_R2_________________, KC_MINS, \
-  KC_LSFT, _________________DVORAK_L3_________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________DVORAK_R3_________________, KC_LGUI \
+  KC_MLSF, _________________DVORAK_L3_________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________DVORAK_R3_________________, KC_LGUI \
 ),
 [_WORKMAN] = KEYMAP_wrapper(\
   KC_ESC,  _________________WORKMAN_L1________________,                                                               _________________WORKMAN_R1________________, KC_BSPC, \
   KC_TAB,  _________________WORKMAN_L2________________,          KC_UP,   KC_DOWN,         KC_LEFT, KC_RIGHT,         _________________WORKMAN_R2________________, KC_MINS, \
-  KC_LSFT, _________________WORKMAN_L3________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________WORKMAN_R3________________, KC_LGUI \
+  KC_MLSF, _________________WORKMAN_L3________________, LOWER,   KC_SPACE,KC_BSPC,         KC_DEL,  KC_ENT,  RAISE,   _________________WORKMAN_R3________________, KC_LGUI \
 ),
 [_MODS] = KEYMAP(\
   _______, _______, _______, _______, _______, _______,                                                               _______, _______, _______, _______, _______, _______,  \
   _______, _______, _______, _______, _______, _______,          _______, _______,         _______, _______,          _______, _______, _______, _______, _______, _______, \
-  OSM(MOD_LSFT), _______, _______, _______, _______, _______, _______, _______, _______,   _______, _______, _______, _______, _______, _______, _______, _______, _______  \
+  KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______,         _______, _______, _______, _______, _______, _______, _______, _______, _______  \
 ),
 
 [_LOWER] = KEYMAP(\

keyboards/planck/keymaps/corvec/config.h

@@ -0,0 +1,53 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.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
+
+#define PERMISSIVE_HOLD
+
+// AutoShift config
+#define AUTO_SHIFT_TIMEOUT 135
+#define NO_AUTO_SHIFT_SPECIAL
+// #define NO_AUTO_SHIFT_NUMERIC
+// #define NO_AUTO_SHIFT_ALPHA
+
+// TapDance config
+#define TAPPING_TERM 150
+
+#endif

keyboards/planck/keymaps/corvec/keymap.c

@@ -0,0 +1,207 @@
+/* Copyright 2015-2018 Jack Humbert, Corey Kump
+ *
+ * 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 {
+  _COLEMAK,
+  _QWERTY,
+  _LOWER,
+  _LEANDOWN,
+  _RAISE,
+  _WOBBLE,
+  _PLOVER,
+  _ADJUST
+};
+
+/* This include relies on the layer constants above and so must be declared after them */
+#include "tapdance.c"
+
+enum planck_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  LOWER,
+  RAISE,
+  BACKLIT
+};
+
+#define KC_ KC_TRNS
+#define KC_____ KC_TRNS
+#define KC_XXXX KC_NO
+#define KC_LOWR LOWER
+#define KC_RASE RAISE
+
+/**
+ * Custom Corvec Bindings
+ *
+ * Previously used but currently unused bindings are commented out.
+ **/
+
+// Activate the Wobble layer
+#define KC_WOBL MO(_WOBBLE)
+// Dual function with Raise
+#define KC_RESC LT(_RAISE, KC_ESC)
+// Dual functions with Lower
+#define KC_LENT LT(_LOWER, KC_ENT)
+#define KC_LQUT LT(_LEANDOWN, KC_QUOT)
+// Dual functions with Shift
+#define KC_SDEL MT(MOD_LSFT, KC_DEL)
+#define KC_SAPP MT(MOD_LSFT, KC_APP)
+
+/**
+ * Functions taking advantage of tap dance:
+ **/
+// Tap once: quote. Hold: LEANDOWN layer. Tap twice: minus.
+#define KC_TQTD TD(TD_QUOT_LEAN_MINS)
+// Tap once: [. Hold: RALT. Tap twice: {
+#define KC_TALT TD(TD_LBRC_RALT_LCBR)
+// Tap once: ]. Hold: RGUI. Tap twice: }
+#define KC_TGUI TD(TD_RBRC_RGUI_RCBR)
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  [_COLEMAK] = KC_KEYMAP(
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     TAB , Q  , W  , F  , P  , G  , J  , L  , U  , Y  ,SCLN,BSPC,
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     RESC, A  , R  , S  , T  , D  , H  , N  , E  , I  , O  ,TQTD,
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     LSFT, Z  , X  , C  , V  , B  , K  , M  ,COMM,DOT ,SLSH,RSFT,
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     LCTL,LGUI,WOBL,LALT,LENT, SPC, SPC,RASE,SDEL,TALT,TGUI,RCTL
+  ),
+
+  [_QWERTY] = KC_KEYMAP(
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     TAB , Q  , W  , E  , R  , T  , Y  , U  , I  , O  , P  ,BSPC,
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     RESC, A  , S  , D  , F  , G  , H  , J  , K  , L  ,SCLN,TQTD,
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     LSFT, Z  , X  , C  , V  , B  , N  , M  ,COMM,DOT ,SLSH,RSFT,
+  //-----+----+----+----+----+----+----+----+----+----+----+----
+     LCTL,LGUI,WOBL,LALT,LENT, SPC, SPC,RASE,RALT,SAPP,RGUI,RCTL
+  ),
+
+  [_LOWER] = KC_KEYMAP(
+     GRV ,EXLM, AT ,HASH, DLR,PERC,CIRC,AMPR,ASTR,LPRN,RPRN,____,
+     ____,LPRN,RPRN,LBRC,RBRC,XXXX,LEFT,DOWN, UP ,RGHT,XXXX,MINS,
+     ____,BSLS,TILD,PIPE,EQL ,UNDS,HOME,PGDN,PGUP,END ,BSLS,____,
+     ____,____,____,____,____,____,____,____,____,____,____,____
+  ),
+
+  [_LEANDOWN] = KC_KEYMAP(
+     GRV ,EXLM, AT ,HASH, DLR,PERC,CIRC,AMPR,ASTR,LPRN,RPRN,____,
+     ____,LPRN,RPRN,LBRC,RBRC,LCBR,LCBR,DLR ,PERC,CIRC,____,____,
+     ____,BSLS,TILD,PIPE,EQL ,UNDS,HOME,EXLM, AT ,HASH,BSLS,____,
+     ____,____,____,____,____,____,____,____,LEFT,DOWN, UP ,RGHT
+  ),
+
+  [_RAISE] = KC_KEYMAP(
+     GRV ,  1 ,  2 ,  3 ,  4 ,  5 ,  6 ,  7 ,  8 ,  9 ,  0 ,____,
+     ____,LPRN,RPRN,LCBR,RCBR,XXXX,XXXX,  4 ,  5 ,  6 ,PPLS,MINS,
+     ____,BSLS,TILD,PIPE,EQL ,UNDS,XXXX,  1 ,  2 ,  3 ,PAST,____,
+     ____,____,____,____,____,____,____,____,____,____,____,____
+  ),
+
+  [_WOBBLE] = KC_KEYMAP(
+     GRV , F1 , F2 , F3 , F4 , NO ,MUTE,VOLD,VOLU, NO , NO , DEL,
+         , F5 , F6 , F7 , F8 , NO ,MPRV,MPLY,MSTP,MNXT, NO ,BSLS,
+         , F9 , F10, F11, F12, NO , NO , NO , NO , INS,PSCR,    ,
+         ,    ,    ,    ,    ,    ,    ,    ,    ,    ,    ,
+  ),
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * |Colemk|      | Debug|RGB Tg|RGB Md|RGB H+|RGB H-|RGB S+|RGB S-|RGB V+|RGB V-|Qwerty|
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |      |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|      |AS On | AS + |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|TermOn|TermOf|AS Rep|AS Off| AS - |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      | Reset|
+ * `-----------------------------------------------------------------------------------'
+ */
+
+[_ADJUST] = {
+  {COLEMAK, _______,   DEBUG,    RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, QWERTY },
+  {_______, _______, MU_MOD,   AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, _______, KC_ASON, KC_ASUP},
+  {_______, MUV_DE,  MUV_IN,   MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  TERM_ON, TERM_OFF,KC_ASRP, KC_ASOFF,KC_ASDN},
+  {_______, _______, _______,  _______, _______, _______, _______, _______, _______, _______, _______, RESET  }
+}
+
+
+};
+
+#ifdef AUDIO_ENABLE
+  float plover_song[][2]     = SONG(PLOVER_SOUND);
+  float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
+#endif
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+        print("mode just switched to qwerty and this is a huge string\n");
+        set_single_persistent_default_layer(_QWERTY);
+      }
+      return false;
+      break;
+    case COLEMAK:
+      if (record->event.pressed) {
+        set_single_persistent_default_layer(_COLEMAK);
+      }
+      return false;
+      break;
+    case LOWER:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case RAISE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case BACKLIT:
+      if (record->event.pressed) {
+        register_code(KC_RSFT);
+        #ifdef BACKLIGHT_ENABLE
+          backlight_step();
+        #endif
+        PORTE &= ~(1<<6);
+      } else {
+        unregister_code(KC_RSFT);
+        PORTE |= (1<<6);
+      }
+      return false;
+      break;
+  }
+  return true;
+}

keyboards/planck/keymaps/corvec/readme.md

@@ -0,0 +1,28 @@
+# Corvec's Planck Layout
+
+This layout is a development-focused layout with an emphasis on ergonomics. It is intended to be used in Colemak mode,
+but has a full-QWERTY mode for gaming compatibility.
+
+It utilizes redundancy for common keys so that they are more easily accessible in every task. For example, the common
+layers, Raise and Lower, both can be activated with two different keys, each pressed with either hand. Certain symbols
+( \~|+_ ) are on both layers, since the keys they take up are a bit out of the way. The minus symbol is available on the
+quote key in a variety of ways - both layers, as well as via tap dance.
+
+The right-hand Lower activation key activates a slightly different layer. The keys accessed by the opposite hand are the
+same as the Lower layer, but the keys on the right hand differ. For this reason, we refer to this instead as the
+Leandown layer.
+
+Auto-shift is enabled, but there are also three shift keys, since typing with auto-shift is by necessity slow.
+
+Movement is done Vim-style, on the hjkl / hnei keys, on the Lower layer so that it is easiest to activate it.
+The arrow keys are mimicked by Home/PgDn/PgUp/End on the next row.
+
+The arrow keys and broad navigation keys are replaced by a symbol-pad on the Leandown layer. However, in order to allow
+single-hand navigation, the bottom right corner cluster becomes arrow keys.
+
+Media keys are in the same location as the arrow keys, but are on the Wobble layer instead.
+
+Toggle layers are minimized so that the state of the keyboard is more predictable. Shift Toggle is in the works, but
+will not be included until it can be set to deactivate automatically.
+
+Delete is accessible from the third Shift key.

keyboards/planck/keymaps/corvec/rules.mk

@@ -0,0 +1,5 @@
+AUTO_SHIFT_ENABLE = yes
+TAP_DANCE_ENABLE = yes
+API_SYSEX_ENABLE = no
+CONSOLE_ENABLE = no
+EXTRAKEY_ENABLE = no

keyboards/planck/keymaps/corvec/tapdance.c

@@ -0,0 +1,156 @@
+/**
+ * Tap Dance config and functions
+ **/
+/* Copyright 2018 Corey Kump
+ *
+ * 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/>.
+ */
+
+enum {
+    SINGLE_TAP = 1,
+    SINGLE_HOLD = 2,
+    DOUBLE_TAP = 3,
+    DOUBLE_SINGLE_TAP = 4,
+    UNKNOWN_TAPS = 5
+};
+
+typedef struct {
+  bool is_press_action;
+  int state;
+} tap;
+
+int cur_dance (qk_tap_dance_state_t *state) {
+    if (state->count == 1) {
+      if (state->interrupted || !state->pressed) {
+        return SINGLE_TAP;
+      } else {
+        return SINGLE_HOLD;
+      }
+    }
+    if (state->count == 2) {
+      if (state->interrupted) {
+        return DOUBLE_SINGLE_TAP;
+      } else if (!state->pressed) {
+        return DOUBLE_TAP;
+      }
+    }
+    return UNKNOWN_TAPS;
+}
+
+/**
+ * quote
+ **/
+
+static tap quote_state = {
+  .is_press_action = true,
+  .state = 0
+};
+
+void quote_finished(qk_tap_dance_state_t *state, void *user_data) {
+    quote_state.state = cur_dance(state);
+    switch(quote_state.state) {
+      case SINGLE_TAP: register_code(KC_QUOT); break;
+      case SINGLE_HOLD: layer_on(_LEANDOWN); break;
+      case DOUBLE_TAP: register_code(KC_MINS); break;
+      case DOUBLE_SINGLE_TAP: register_code(KC_QUOT); unregister_code(KC_QUOT); register_code(KC_QUOT); break;
+    }
+}
+void quote_reset(qk_tap_dance_state_t *state, void *user_data) {
+    switch(quote_state.state) {
+      case SINGLE_TAP: unregister_code(KC_QUOT); break;
+      case SINGLE_HOLD: layer_off(_LEANDOWN); break;
+      case DOUBLE_TAP: unregister_code(KC_MINS); break;
+      case DOUBLE_SINGLE_TAP: unregister_code(KC_QUOT); break;
+    }
+    quote_state.state = 0;
+}
+
+/**
+ * ralt / left bracket / left curly brace
+ **/
+
+static tap ralt_state = {
+  .is_press_action = true,
+  .state = 0
+};
+
+void ralt_finished(qk_tap_dance_state_t *state, void *user_data) {
+    ralt_state.state = cur_dance(state);
+    switch(ralt_state.state) {
+      case SINGLE_TAP: register_code(KC_LBRC); break;
+      case SINGLE_HOLD: register_code(KC_RALT); break;
+      case DOUBLE_TAP: register_code(KC_LSFT); register_code(KC_LBRC); break;
+      // fallback to alt because it's the primary purpose of this key
+      case DOUBLE_SINGLE_TAP: register_code(KC_RALT); break;
+    }
+}
+void ralt_reset(qk_tap_dance_state_t *state, void *user_data) {
+    switch(ralt_state.state) {
+      case SINGLE_TAP: unregister_code(KC_LBRC); break;
+      case SINGLE_HOLD: unregister_code(KC_RALT); break;
+      case DOUBLE_TAP: unregister_code(KC_LBRC); unregister_code(KC_LSFT); break;
+      case DOUBLE_SINGLE_TAP: unregister_code(KC_RALT); break;
+    }
+    ralt_state.state = 0;
+}
+
+/**
+ * rgui / right bracket / right curly brace
+ **/
+
+static tap rgui_state = {
+  .is_press_action = true,
+  .state = 0
+};
+
+void rgui_finished(qk_tap_dance_state_t *state, void *user_data) {
+    rgui_state.state = cur_dance(state);
+    switch(rgui_state.state) {
+      case SINGLE_TAP: register_code(KC_RBRC); break;
+      case SINGLE_HOLD: register_code(KC_RGUI); break;
+      case DOUBLE_TAP: register_code(KC_LSFT); register_code(KC_RBRC); break;
+      // fallback to alt because it's the primary purpose of this key
+      case DOUBLE_SINGLE_TAP: register_code(KC_RGUI); break;
+    }
+}
+void rgui_reset(qk_tap_dance_state_t *state, void *user_data) {
+    switch(rgui_state.state) {
+      case SINGLE_TAP: unregister_code(KC_RBRC); break;
+      case SINGLE_HOLD: unregister_code(KC_RGUI); break;
+      case DOUBLE_TAP: unregister_code(KC_RBRC); unregister_code(KC_LSFT); break;
+      case DOUBLE_SINGLE_TAP: unregister_code(KC_RGUI); break;
+    }
+    rgui_state.state = 0;
+}
+
+/**
+ * Define the available tap dance keys
+ **/
+
+enum {
+  TD_ALT_SHIFT = 0,
+  TD_LQUT_MINS,
+  TD_QUOT_LEAN_MINS,
+  TD_LBRC_RALT_LCBR,
+  TD_RBRC_RGUI_RCBR
+};
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+  // Tap once for Alt, twice for Shift
+  [TD_ALT_SHIFT] = ACTION_TAP_DANCE_DOUBLE(KC_RALT, KC_RSFT),
+  [TD_QUOT_LEAN_MINS] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, quote_finished, quote_reset),
+  [TD_LBRC_RALT_LCBR] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, ralt_finished, ralt_reset),
+  [TD_RBRC_RGUI_RCBR] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, rgui_finished, rgui_reset)
+};
+

keyboards/planck/keymaps/grahampheath/readme.md

@@ -1,4 +1,4 @@
 # Graham's Planck
 
 ## Sounds
-I've added a [8ohm 0.5W speaker](http://a.co/6MIKZSy), its a bit large, but it fits in approximately the same space as the ProMicro. I soldered to the pcb hole labeled PC6 on my Rev 3 Planck PCB, and GND on the near by chip. [Pic of an identical mod][https://i1.sndcdn.com/artworks-000128070066-myh0ls-t500x500.jpg] (not mine).
+I've added a [8ohm 0.5W speaker](http://a.co/6MIKZSy), its a bit large, but it fits in approximately the same space as the ProMicro. I soldered to the pcb hole labeled PC6 on my Rev 3 Planck PCB, and GND on the near by chip. [Pic of an identical mod](https://i1.sndcdn.com/artworks-000128070066-myh0ls-t500x500.jpg) (not mine).

keyboards/planck/keymaps/navi/config.h

@@ -0,0 +1,30 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.h"
+
+/*
+ * 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

keyboards/planck/keymaps/navi/keymap.c

@@ -0,0 +1,298 @@
+/* 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.
+ * cd /c/qmk_firmware
+ * make planck/rev4:navi
+ * 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"
+#ifdef AUDIO_ENABLE
+  #include "audio.h"
+  #include "song_list.h"
+#endif
+
+extern keymap_config_t keymap_config;
+
+enum planck_layers {
+  _QWERTY,
+  _COLEMAK,
+  _PLOVER,
+  _LOWER,
+  _RAISE,
+  _ADJUST,
+  _FUNCTION
+};
+
+enum planck_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  PLOVER,
+  LOWER,
+  RAISE,
+  EXT_PLV,
+  FUNCTION
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | CtlE |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |  FN  |CtlSE |  GUI |  Alt | Lower|    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ * CtlSE = Control+shift+esc/
+ * CtlE = Control when held, esc when tapped
+  */
+[_QWERTY] = {
+  {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
+  {LCTL_T(KC_ESC),  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
+  {FUNCTION, C_S_T(KC_ESC), KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+
+/* Colemak
+ * ,-----------------------------------------------------------------------------------.
+ * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | CtlE |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |  FN  |CtlSE |  GUI |  Alt |Lower |    Space    | Raise| Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_COLEMAK] = {
+  {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
+  {LCTL_T(KC_ESC),  KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT },
+  {FUNCTION, C_S_T(KC_ESC), KC_LGUI, KC_LALT, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+
+/* Plover layer (http://opensteno.org)
+ * ,-----------------------------------------------------------------------------------.
+ * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Exit |      |      |   A  |   O  |             |   E  |   U  |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+
+[_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},
+  {EXT_PLV, XXXXXXX, XXXXXXX, KC_C,    KC_V,    XXXXXXX, XXXXXXX, KC_N,    KC_M,    XXXXXXX, XXXXXXX, XXXXXXX}
+},
+
+
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |  ISO |  End | Home |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |Pg DN | Pg UP|      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = {
+  {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS,    KC_PLUS,    KC_LCBR, KC_RCBR, KC_PIPE},
+  {KC_LSHIFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  S(KC_NUHS), S(KC_NUBS), KC_END, KC_HOME,  _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______,    _______, KC_PGDN  , KC_PGUP, _______}
+},
+
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  | Del  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |Shift |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / | End  | Home |       |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |Pg DN |Pg UP |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = {
+  {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR,    KC_ASTR,    KC_LPRN, KC_RPRN, KC_DEL},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
+  {KC_LSHIFT, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_END, KC_HOME,  _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______,    _______, KC_PGDN  , KC_PGUP, _______}
+},
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      |MU_MOD|Aud on|Audoff|      |      |Qwerty|Colemk|Plover|      |      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |Caps  |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof|      |      |      |      | Caps |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = {
+  {_______, RESET,   DEBUG,    RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, KC_DEL },
+  {_______, _______, MU_MOD,  AU_ON,   AU_OFF,  _______, _______, QWERTY,  COLEMAK, PLOVER,_______,  _______},
+  {KC_CAPS, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  TERM_ON, TERM_OFF, _______, _______, KC_CAPS},
+  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
+},
+
+/* Function
+ * ,-----------------------------------------------------------------------------------.
+ * | Esc  |      | Prev | Play | Next |      |      |      |  7   |  8   |  9   | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |      | Vol- | Mute | Vol+ |      |      |   +  |  4   |  5   |  6   |  -   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | CALC |      |      |      |      |      |      |   $  |  1   |  2   |  3   | Enter|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |Prntsc|      |      |             |   *  |  0   |  .   |Numlck|  /   |
+ * `-----------------------------------------------------------------------------------'
+ */
+
+[_FUNCTION] = { 
+  {KC_ESC , _______, KC_MPRV, KC_MPLY, KC_MNXT, _______,_______,_______, KC_KP_7, KC_KP_8, KC_KP_9,KC_BSPC},
+  {_______, _______, KC_VOLD, KC_MUTE, KC_VOLU, _______, _______, KC_PPLS, KC_KP_4, KC_KP_5, KC_KP_6, KC_PMNS},
+  {KC_CALC, _______, _______, _______, _______, _______, _______, KC_DLR, KC_KP_1, KC_KP_2, KC_KP_3, KC_ENT},
+  {_______, _______, KC_PSCR, _______, _______ , _______, _______, KC_PAST, KC_KP_0, KC_KP_DOT,KC_NUMLOCK, KC_PSLS}
+}
+
+};
+
+#ifdef AUDIO_ENABLE
+float tone_startup[][2]    = SONG(ZELDA_PUZZLE);
+float tone_qwerty[][2]     = SONG(ZELDA_TREASURE);
+float plover_song[][2]     = SONG(PLOVER_SOUND);
+float plover_gb_song[][2] = SONG(PLOVER_GOODBYE_SOUND);
+float tone_colemak[][2]    = SONG(VIOLIN_SOUND);
+float tone_music_on[][2]   = SONG(ONE_UP_SOUND);
+float tone_music_off[][2]  = SONG(ROCK_A_BYE_BABY);
+#endif /* AUDIO_ENABLE */
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case QWERTY:
+      if (record->event.pressed) {
+		  print("mode just switched to qwerty and this is a huge string\n");
+		  set_single_persistent_default_layer(_QWERTY);
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(tone_qwerty);
+        #endif
+      }
+      return false;
+      break;
+    case COLEMAK:
+      if (record->event.pressed) {
+		  set_single_persistent_default_layer(_COLEMAK);
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(tone_colemak);
+        #endif
+      }
+      return false;
+      break;
+    case LOWER:
+      if (record->event.pressed) {
+        layer_on(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_LOWER);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+    case RAISE:
+      if (record->event.pressed) {
+        layer_on(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      } else {
+        layer_off(_RAISE);
+        update_tri_layer(_LOWER, _RAISE, _ADJUST);
+      }
+      return false;
+      break;
+	case FUNCTION:
+      if (record->event.pressed) {
+        layer_on(_FUNCTION);
+      } else {
+        layer_off(_FUNCTION);
+      }
+      return false;
+      break;
+	case PLOVER:
+      if (record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          stop_all_notes();
+          PLAY_SONG(plover_song);
+        #endif
+        layer_off(_RAISE);
+        layer_off(_LOWER);
+        layer_off(_ADJUST);
+        layer_on(_PLOVER);
+        if (!eeconfig_is_enabled()) {
+            eeconfig_init();
+        }
+        keymap_config.raw = eeconfig_read_keymap();
+        keymap_config.nkro = 1;
+        eeconfig_update_keymap(keymap_config.raw);
+      }
+      return false;
+      break;
+    case EXT_PLV:
+      if (record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(plover_gb_song);
+        #endif
+        layer_off(_PLOVER);
+      }
+      return false;
+      break;
+  }
+  return true;
+}
+
+void matrix_init_user(void) {
+    #ifdef AUDIO_ENABLE
+        startup_user();
+    #endif
+}
+
+#ifdef AUDIO_ENABLE
+
+void startup_user()
+{
+    _delay_ms(20); // gets rid of tick
+    PLAY_SONG(tone_startup);
+}
+
+void music_on_user(void)
+{
+	PLAY_SONG(tone_music_on);
+}
+
+void music_off_user(void)
+{
+	PLAY_SONG(tone_music_off);
+}
+#endif
+
+

keyboards/planck/keymaps/navi/readme.md

@@ -0,0 +1,6 @@
+# Navi (Navigatorade)'s personal key layout.
+# Primarily focused on qwerty & colemak
+# Added a numberpad layer, mainly for accounting
+
+
+

keyboards/planck/keymaps/navi/rules.mk

@@ -0,0 +1 @@
+AUDIO_ENABLE = yes

keyboards/preonic/keymaps/blake-newman/config.h

@@ -0,0 +1,42 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.h"
+
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PREONIC_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

keyboards/preonic/keymaps/blake-newman/keymap.c

@@ -0,0 +1,253 @@
+/* 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 "preonic.h"
+#include "action_layer.h"
+
+enum preonic_layers {
+  _QWERTY,
+  _COLEMAK,
+  _DVORAK,
+  _NUMPAD,
+  _LOWER,
+  _RAISE,
+  _ADJUST
+};
+
+enum preonic_keycodes {
+  QWERTY = SAFE_RANGE,
+  COLEMAK,
+  DVORAK,
+  NUMPAD,
+  LOWER,
+  RAISE,
+  BACKLIT
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+  /* Qwerty
+  * ,-----------------------------------------------------------------------------------.
+  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * | Bksp |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  | Shift|
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |      |  Alt | Ctrl | Shift|
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_QWERTY] = {
+    {KC_GRV,  KC_1,    KC_2,    KC_5,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+    {KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
+    {KC_BSPC, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+    {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
+    {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   _______, KC_RALT, KC_RCTL, KC_RSFT}
+  },
+
+  /* Colemak
+  * ,-----------------------------------------------------------------------------------.
+  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * | Bksp |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  | Shift|
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |      |  Alt | Ctrl | Shift|
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_COLEMAK] = {
+    {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+    {KC_TAB,  KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
+    {KC_BSPC, KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
+    {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT},
+    {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   _______, KC_RALT, KC_RCTL, KC_RSFT}
+  },
+
+  /* Dvorak
+  * ,-----------------------------------------------------------------------------------.
+  * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * | Bksp |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  | Shift|
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |      |  Alt | Ctrl | Shift|
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_DVORAK] = {
+    {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+    {KC_TAB,  KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
+    {KC_BSPC, KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
+    {KC_LSFT, KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    KC_RSFT},
+    {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   _______, KC_RALT, KC_RCTL, KC_RSFT}
+  },
+
+  /* Numpad
+  * ,-----------------------------------------------------------------------------------.
+  * | Esc  |      |      | PgDn | PgUp | Home |  End  |      |   /  |   *  |   -  | Del  |
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Tab  |      |  Up  |      |      |      |      |   7  |   8  |   9  |   +  | Bksp |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * | Bksp | Left | Down | Right|      |      |      |   4  |   5  |   6  |      |  "   |
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * | Shift|      |      |      |      |      |   ,  |   1  |   2  |   3  |      | Shift|
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |   0  |   .  | Ctrl | Shift|
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_NUMPAD] = {
+    {KC_ESC,  _______, _______, KC_PGDN, KC_PGUP, KC_END,  KC_HOME, _______, KC_PSLS, KC_PAST, KC_PMNS, KC_DEL},
+    {KC_TAB,  _______, KC_UP,   _______, _______, _______, _______, KC_P7,   KC_P8,   KC_P9,   KC_PPLS, KC_BSPC},
+    {KC_BSPC, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, KC_P4,   KC_P5,   KC_P6,   _______, KC_QUOT},
+    {KC_LSFT, _______, _______, _______, _______, _______, KC_COMM, KC_P1,   KC_P2,   KC_P3,   _______, KC_RSFT},
+    {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_P0,   KC_PDOT, KC_RCTL, KC_RSFT}
+  },
+
+
+  /* Lower
+  * ,-----------------------------------------------------------------------------------.
+  * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * |  Esc |      |  Up  |      |      |      |      |   -_ |   -  |   +  |   =  | Bksp |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * |  Bksp| Left | Down | Right|      |      |      |   {  |   }  |   [  |   ]  |   \  |
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * | Shift|   |  |      |      |      |      |      |      |      |   ¢  |   €  | Shift|
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Brite| Ctrl | Alt  | GUI  |Lower |    Enter    |Raise |      |  Alt | Ctrl | Shift|
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_LOWER] = {
+    {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12},
+    {KC_ESC,  _______, KC_UP,   _______, _______, _______, _______, KC_UNDS, KC_MINS, KC_PLUS, KC_EQL,  KC_BSPC},
+    {KC_BSPC, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, KC_BSLS},
+    {KC_LSFT, KC_PIPE, _______, _______, _______, _______, _______, _______, ALGR_T(KC_4), ALGR_T(KC_5), _______,  KC_RSFT},
+    {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_ENT,  KC_ENT,  RAISE,   _______, KC_RALT, KC_RCTL, KC_RSFT}
+  },
+
+  /* Raise
+  * ,-----------------------------------------------------------------------------------.
+  * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * |  Esc |      |  Up  |      |      |      |      |   -  |   _  |   =  |   +  | Bksp |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * | Bksp | Left | Down | Right|      |      |      |   [  |  ]   |   {  |   }  |   |  |
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * | Shift|  \   |      |      |      |      |      |      |      |   £  |  $   | Shift|
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * | Brite| Ctrl | Alt  | GUI  |Lower |    Enter    |Raise |      |  Alt | Ctrl | Shift|
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_RAISE] = {
+    {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12},
+    {KC_ESC,  _______, KC_UP,   _______, _______, _______, _______, KC_MINS, KC_UNDS, KC_EQL,  KC_PLUS, KC_BSPC},
+    {KC_BSPC, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, KC_LBRC, KC_RBRC, KC_LCBR, KC_RCBR, KC_PIPE},
+    {KC_LSFT, KC_BSLS, _______, _______, _______, _______, _______, _______, _______, ALGR_T(KC_DLR), KC_DLR,  KC_RSFT},
+    {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_ENT,  KC_ENT,  RAISE,   _______, KC_RALT, KC_RCTL, KC_RSFT}
+  },
+
+  /* Adjust (Lower + Raise)
+  * ,-----------------------------------------------------------------------------------.
+  * |      |      |      |      |      |      |      |      |      |      |      |      |
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * |      | Reset| Debug|      |      |      |      |      |      | aPscr| sPscr| Pscr |
+  * |------+------+------+------+------+-------------+------+------+------+------+------|
+  * | Caps |      |      |Aud on|AudOff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Numpad|Insert|
+  * |------+------+------+------+------+------|------+------+------+------+------+------|
+  * |      |Voice-|Voice+|Mus on|MusOff|MidiOn|MidOff|      |      |      |      |      |
+  * |------+------+------+------+------+------+------+------+------+------+------+------|
+  * |      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+  * `-----------------------------------------------------------------------------------'
+  */
+  [_ADJUST] = {
+    {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
+    {_______, RESET,   DEBUG,   _______, _______, _______, _______, TERM_ON, TERM_OFF,LALT(KC_PSCR), LCTL(KC_PSCR), KC_PSCR},
+    {KC_CAPS, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  COLEMAK, DVORAK,  NUMPAD,  KC_INS},
+    {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
+    {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
+  }
+
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+        case QWERTY:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_QWERTY);
+          }
+          return false;
+          break;
+        case COLEMAK:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_COLEMAK);
+          }
+          return false;
+          break;
+        case DVORAK:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_DVORAK);
+          }
+          return false;
+          break;
+        case NUMPAD:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_NUMPAD);
+          }
+          return false;
+          break;
+        case LOWER:
+          if (record->event.pressed) {
+            layer_on(_LOWER);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          } else {
+            layer_off(_LOWER);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          }
+          return false;
+          break;
+        case RAISE:
+          if (record->event.pressed) {
+            layer_on(_RAISE);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          } else {
+            layer_off(_RAISE);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          }
+          return false;
+          break;
+        case BACKLIT:
+          if (record->event.pressed) {
+            register_code(KC_RSFT);
+            #ifdef BACKLIGHT_ENABLE
+              backlight_step();
+            #endif
+            PORTE &= ~(1<<6);
+          } else {
+            unregister_code(KC_RSFT);
+            PORTE |= (1<<6);
+          }
+          return false;
+          break;
+      }
+    return true;
+};

keyboards/preonic/keymaps/blake-newman/readme.md

@@ -0,0 +1,108 @@
+# Preonic layout by [Blake Newman](https://github.com/blake-newman)
+
+## Layouts
+
+### Qwerty
+```
+,-----------------------------------------------------------------------------------.
+|   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Bksp |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |  "   |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  | Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |      |  Alt | Ctrl | Shift|
+`-----------------------------------------------------------------------------------'
+```
+
+### Colemak
+```
+,-----------------------------------------------------------------------------------.
+|   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Bksp |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |  "   |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  | Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |      |  Alt | Ctrl | Shift|
+`-----------------------------------------------------------------------------------'
+```
+
+### Dvorak
+```
+,-----------------------------------------------------------------------------------.
+|   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  | Del  |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Tab  |   "  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Bksp |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  | Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |      |  Alt | Ctrl | Shift|
+`-----------------------------------------------------------------------------------'
+```
+
+### Numpad
+```
+,-----------------------------------------------------------------------------------.
+| Esc  |      |      | PgDn | PgUp | Home |  End  |      |   /  |   *  |   -  | Del  |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Tab  |      |  Up  |      |      |      |      |   7  |   8  |   9  |   +  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Bksp | Left | Down | Right|      |      |      |   4  |   5  |   6  |      |  "   |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|      |      |      |      |      |   ,  |   1  |   2  |   3  |      | Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Brite| Ctrl | Alt  | GUI  |Lower |    Space    |Raise |   0  |   .  | Ctrl | Shift|
+`-----------------------------------------------------------------------------------'
+```
+
+### Lower
+```
+,-----------------------------------------------------------------------------------.
+|  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|  Esc |      |  Up  |      |      |      |      |   -_ |   -  |   +  |   =  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|  Bksp| Left | Down | Right|      |      |      |   {  |   }  |   [  |   ]  |   \  |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|   |  |      |      |      |      |      |      |      |   ¢  |   €  | Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Brite| Ctrl | Alt  | GUI  |Lower |    Enter    |Raise |      |  Alt | Ctrl | Shift|
+`-----------------------------------------------------------------------------------'
+```
+
+### Raise
+```
+,-----------------------------------------------------------------------------------.
+|  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+|  Esc |      |  Up  |      |      |      |      |   -  |   _  |   =  |   +  | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Bksp | Left | Down | Right|      |      |      |   [  |  ]   |   {  |   }  |   |  |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift|  \   |      |      |      |      |      |      |      |   £  |  $   | Shift|
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| Brite| Ctrl | Alt  | GUI  |Lower |    Enter    |Raise |      |  Alt | Ctrl | Shift|
+`-----------------------------------------------------------------------------------'
+```
+
+### Adjust (Lower + Raise)
+```
+,-----------------------------------------------------------------------------------.
+|      |      |      |      |      |      |      |      |      |      |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      | Reset| Debug|      |      |      |      |      |      | aPscr| sPscr| Pscr |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Caps |      |      |Aud on|AudOff|AGnorm|AGswap|Qwerty|Colemk|Dvorak|Numpad|Insert|
+|------+------+------+------+------+------|------+------+------+------+------+------|
+|      |Voice-|Voice+|Mus on|MusOff|MidiOn|MidOff|      |      |      |      |      |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+|      |      |      |      |      |             |      | Next | Vol- | Vol+ | Play |
+`-----------------------------------------------------------------------------------'
+```

keyboards/preonic/keymaps/dudeofawesome/config.h

@@ -0,0 +1,53 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "config_common.h"
+
+#define TAPPING_TOGGLE 2
+
+#ifdef AUDIO_ENABLE
+    #define STARTUP_SONG SONG(PLANCK_SOUND)
+    // #define STARTUP_SONG SONG(NO_SOUND)
+
+    #define WORKMAN_SOUND \
+        E__NOTE(_GS7),    \
+        ED_NOTE(_E7),     \
+        S__NOTE(_REST),   \
+        E__NOTE(_A6),     \
+        S__NOTE(_REST),   \
+        ED_NOTE(_GS6),
+
+    #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
+                                  SONG(WORKMAN_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

keyboards/preonic/keymaps/dudeofawesome/keymap.c

@@ -0,0 +1,275 @@
+/* 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 "preonic.h"
+#include "action_layer.h"
+
+enum preonic_layers {
+  _QWERTY,
+  _WORKMAN,
+  _COLEMAK,
+  _DVORAK,
+  _LOWER,
+  _RAISE,
+  _ADJUST,
+  _NUMPAD
+};
+
+enum preonic_keycodes {
+  QWERTY = SAFE_RANGE,
+  WORKMAN,
+  COLEMAK,
+  DVORAK,
+  LOWER,
+  RAISE,
+  BACKLIT
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |  Del |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Tab  |   Q  |   W  |   E  |   R  |   T  |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   S  |   D  |   F  |   G  |   H  |   J  |   K  |   L  |   ;  |   '  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   N  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Num  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_QWERTY] = {
+  {KC_GRV,       KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+  {KC_TAB,       KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC},
+  {KC_ESC,       KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT},
+  {KC_LSFT,      KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, RSFT_T(KC_ENT)},
+  {TT(_NUMPAD),  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+
+/* Workman
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |  Del |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Tab  |   Q  |   W  |   R  |   W  |   B  |   J  |   F  |   U  |   P  |   ;  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   S  |   H  |   T  |   G  |   Y  |   N  |   E  |   O  |   I  |   '  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   M  |   C  |   V  |   K  |   L  |   ,  |   .  |   /  | Enter|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Num  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_WORKMAN] = {
+  {KC_GRV,       KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+  {KC_TAB,       KC_Q,    KC_D,    KC_R,    KC_W,    KC_B,    KC_J,    KC_F,    KC_U,    KC_P,    KC_SCLN, KC_BSPC},
+  {KC_ESC,       KC_A,    KC_S,    KC_H,    KC_T,    KC_G,    KC_Y,    KC_N,    KC_E,    KC_O,    KC_I,    KC_QUOT},
+  {KC_LSFT,      KC_Z,    KC_X,    KC_M,    KC_C,    KC_V,    KC_K,    KC_L,    KC_COMM, KC_DOT,  KC_SLSH, RSFT_T(KC_ENT)},
+  {TT(_NUMPAD),  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+
+/* Colemak
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |  Del |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Tab  |   Q  |   W  |   F  |   P  |   G  |   J  |   L  |   U  |   Y  |   ;  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   R  |   S  |   T  |   D  |   H  |   N  |   E  |   I  |   O  |   '  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   Z  |   X  |   C  |   V  |   B  |   K  |   M  |   ,  |   .  |   /  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Num  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_COLEMAK] = {
+  {KC_GRV,       KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+  {KC_TAB,       KC_Q,    KC_W,    KC_F,    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN, KC_BSPC},
+  {KC_ESC,       KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,    KC_QUOT},
+  {KC_LSFT,      KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, RSFT_T(KC_ENT)},
+  {TT(_NUMPAD),  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+
+/* Dvorak
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |  Del |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Tab  |   '  |   ,  |   .  |   P  |   Y  |   F  |   G  |   C  |   R  |   L  | Bksp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Esc  |   A  |   O  |   E  |   U  |   I  |   D  |   H  |   T  |   N  |   S  |  /   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * | Shift|   ;  |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  |Enter |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Num  | Ctrl | Alt  | GUI  |Lower |    Space    |Raise | Left | Down |  Up  |Right |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_DVORAK] = {
+  {KC_GRV,       KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL},
+  {KC_TAB,       KC_QUOT, KC_COMM, KC_DOT,  KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L,    KC_BSPC},
+  {KC_ESC,       KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S,    KC_SLSH},
+  {KC_LSFT,      KC_SCLN, KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z,    RSFT_T(KC_ENT)},
+  {TT(_NUMPAD),  KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT}
+},
+
+/* Lower
+ * ,-----------------------------------------------------------------------------------.
+ * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |   ~  |   !  |   @  |   #  |   $  |   %  |   ^  |   &  |   *  |   (  |   )  |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   _  |   +  |   {  |   }  |  |   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO ~ |ISO | |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Play | Vol- | Vol+ | Next |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_LOWER] = {
+  {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,  _______},
+  {KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN,  _______},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR,  KC_PIPE},
+  {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,S(KC_NUHS),S(KC_NUBS),KC_HOME, KC_END, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, KC_MPLY, KC_VOLD, KC_VOLU,  KC_MNXT}
+},
+
+/* Raise
+ * ,-----------------------------------------------------------------------------------.
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |   `  |   1  |   2  |   3  |   4  |   5  |   6  |   7  |   8  |   9  |   0  |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Del  |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |ISO # |ISO / |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      | Play | Vol- | Vol+ | Next |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_RAISE] = {
+  {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______},
+  {KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    _______},
+  {KC_DEL,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS},
+  {_______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_PGUP, KC_PGDN, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, KC_MPLY, KC_VOLD, KC_VOLU, KC_MNXT}
+},
+
+/* Adjust (Lower + Raise)
+ * ,-----------------------------------------------------------------------------------.
+ * |  F1  |  F2  |  F3  |  F4  |  F5  |  F6  |  F7  |  F8  |  F9  |  F10 |  F11 |  F12 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |CPSLCK|      |      |Aud on|AudOff|AGnorm|AGswap|Qwerty|Workmn|Dvorak|Colemk|      |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |Voice-|Voice+|Mus on|MusOff|MidiOn|MidOff|      |      |      |      |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |      |             |      |      |      |      |      |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_ADJUST] = {
+  {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12},
+  {_______, RESET,   DEBUG,   _______, _______, _______, _______, TERM_ON, TERM_OFF,_______, _______, KC_DEL},
+  {KC_CAPS, _______, MU_MOD,  AU_ON,   AU_OFF,  AG_NORM, AG_SWAP, QWERTY,  WORKMAN, DVORAK,  COLEMAK, _______},
+  {_______, MUV_DE,  MUV_IN,  MU_ON,   MU_OFF,  MI_ON,   MI_OFF,  _______, _______, _______, _______, _______},
+  {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
+},
+
+/* Numpad
+ * ,-----------------------------------------------------------------------------------.
+ * |      |   ✗  |   ✗  |   ✗  |   ✗  |   ✗  |   ✗  |   ✗  |   /  |   *  |   -  |      |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |   ✗  | Home |  Up  |  End | PgUp |   ✗  |   7  |   8  |   9  |   +  |      |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |      |   ✗  | Left | Down | Right| PgDn |   ✗  |   4  |   5  |   6  |   +  |   ✗  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |   /  |   *  |   -  |   +  | Enter|   ✗  |   1  |   2  |   3  | Enter| Enter|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |      |      |      |      |   ✗  |             |   0  |   0  |   .  | Enter|   =  |
+ * `-----------------------------------------------------------------------------------'
+ */
+[_NUMPAD] = {
+  {_______, KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO,   KC_NO, KC_PSLS, KC_PAST, KC_PMNS, _______},
+  {_______, KC_NO,   KC_HOME, KC_UP,   KC_END,  KC_PGUP, KC_NO,   KC_P7, KC_P8,   KC_P9,   KC_PPLS, _______},
+  {_______, KC_NO,   KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, KC_NO,   KC_P4, KC_P5,   KC_P6,   KC_PPLS, KC_NO},
+  {_______, KC_PSLS, KC_PAST, KC_PMNS, KC_PPLS, KC_PENT, KC_NO,   KC_P1, KC_P2,   KC_P3,   KC_PENT, KC_PENT},
+  {_______, _______, _______, _______, KC_NO,   _______, _______, KC_P0, KC_P0,   KC_PDOT, KC_PENT, KC_PEQL}
+}
+
+
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+        case QWERTY:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_QWERTY);
+          }
+          return false;
+          break;
+        case WORKMAN:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_WORKMAN);
+          }
+          return false;
+          break;
+        case COLEMAK:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_COLEMAK);
+          }
+          return false;
+          break;
+        case DVORAK:
+          if (record->event.pressed) {
+            set_single_persistent_default_layer(_DVORAK);
+          }
+          return false;
+          break;
+        case LOWER:
+          if (record->event.pressed) {
+            layer_on(_LOWER);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          } else {
+            layer_off(_LOWER);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          }
+          return false;
+          break;
+        case RAISE:
+          if (record->event.pressed) {
+            layer_on(_RAISE);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          } else {
+            layer_off(_RAISE);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          }
+          return false;
+          break;
+        case BACKLIT:
+          if (record->event.pressed) {
+            register_code(KC_RSFT);
+            #ifdef BACKLIGHT_ENABLE
+              backlight_step();
+            #endif
+            PORTE &= ~(1<<6);
+          } else {
+            unregister_code(KC_RSFT);
+            PORTE |= (1<<6);
+          }
+          return false;
+          break;
+      }
+    return true;
+};

keyboards/preonic/keymaps/dudeofawesome/readme.md

@@ -0,0 +1,22 @@
+# DudeOfAwesome's Preonic layout
+
+![Preonic Layout](https://i.imgur.com/EC42Pnw.png)
+
+## Features
+
+- Base Layers
+    - QWERTY
+    - Workman
+    - Dvorak
+    - Colemak
+- Numpad layer
+    ![numpad layer](https://i.imgur.com/V5iGHZg.png)
+- Audio
+
+## Building and flashing
+
+1. Put your board in DFU mode with either the button on the bottom, or with a software key in your current firmware
+1. Flash:
+    ```bash
+    $ make preonic/rev2:dudeofawesome:dfu
+    ```

keyboards/readme.md

@@ -53,7 +53,7 @@ These keyboards are part of the QMK repository, but their manufacturers are not
 * [Lets Split](/keyboards/lets_split) - Split ortholinear 40% keyboard.
 * [Phantom](/keyboards/phantom) — A tenkeyless kit by Teel, also from Geekhack.
 * [Retro Refit](/keyboards/retro_refit) — Another creation by IBNobody.
-* [S60-x](/keyboards/s60-x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq.
+* [S60-x](/keyboards/s60_x) — DIY compact keyboard designed by VinnyCordeiro for Sentraq.
 * [Satan](/keyboards/satan) — A GH60 variant.
 * [SixKeyBoard](/keyboards/sixkeyboard) — A 6-key keyboard made by TechKeys.
 * [TheVan 44](/keyboards/tv44) — A 44-key staggered keybard by Evangs.

keyboards/roadkit/readme.md

@@ -5,7 +5,7 @@ A programmable macro pad.
 
 Keyboard Maintainer: QMK Community
 Hardware Supported: Roadkit PCB
-Hardware Availability: https://thevankeyboards.com/products/roadkit-r2?variant=37353813966
+Hardware Availability: https://thevankeyboards.com/collections/catalog/products/road-kit-diy?variant=603645345806
 
 Make example for this keyboard (after setting up your build environment):
 

keyboards/s60_x/keymaps/custom/readme.md

@@ -1,5 +1,5 @@
 ### 8  Custom
-The custom keymap - [keymap_custom.c](keymap_custom.c) - is where I tested all the switches, not being concerned with a specific layout or layers. It's a plain layout option with the extra keys used on ISO & HHKB layouts being assigned some other keys.
+The custom keymap - [keymap.c](keymap.c) - is where I tested all the switches, not being concerned with a specific layout or layers. It's a plain layout option with the extra keys used on ISO & HHKB layouts being assigned some other keys.
 
 #### 8.0 Default layer
     ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐

keyboards/s60_x/keymaps/hasu/readme.md

@@ -1,4 +1,4 @@
 ### 5. Hasu
-This is Hasu's favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap_hasu.c](keymap_hasu.c) for detail.
+This is Hasu's favorite keymap with HHKB Fn, Vi cursor and Mousekey layer. See [keymap.c](keymap.c) for detail.
 
 (Hasu is the initial creator of the TMK firmware, in case you weren't aware.)

keyboards/s60_x/keymaps/hhkb/readme.md

@@ -1,5 +1,5 @@
 ### 7. HHKB
-[keymap_hhkb.c](keymap_hhkb.c) emulates original HHKB layers.
+[keymap.c](keymap.c) emulates original HHKB layers.
 #### 7.0: Default layer
     ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
     │ Esc │  1  │  2  │  3  │  4  │  5  │  6  │  7  │  8  │  9  │  0  │  -  │  =  │  \  │  `  │

keyboards/s60_x/keymaps/plain/readme.md

@@ -1,6 +1,6 @@
 ### 4. Plain
 Without any Fn layer this will be useful if you want to use key remapping tool like AHK on host.
-See [keymap_plain.c](keymap_plain.c) for detail.
+See [keymap.c](keymap.c) for detail.
 
 #### 4.0 Plain Default layer
     ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐

keyboards/s60_x/keymaps/poker/readme.md

@@ -1,6 +1,6 @@
 ### 3  Poker
-[keymap_poker.c](keymap_poker.c) emulates original Poker layers
+[keymap_poker](../poker/readme.md) emulates original Poker layers
-while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
+while both [keymap_poker_bit](../poker_bit/readme.md) and [keymap_poker_set](../poker_set/readme.md) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
 
     Fn + Esc = `
     Fn + {left, down, up, right}  = {home, pgdown, pgup, end}

keyboards/s60_x/keymaps/poker_bit/readme.md

@@ -1,6 +1,6 @@
 ### 3  Poker
-[keymap_poker.c](keymap_poker.c) emulates original Poker layers
+[keymap_poker](../poker/readme.md) emulates original Poker layers
-while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
+while both [keymap_poker_bit](../poker_bit/readme.md) and [keymap_poker_set](../poker_set/readme.md) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
 
     Fn + Esc = `
     Fn + {left, down, up, right}  = {home, pgdown, pgup, end}

keyboards/s60_x/keymaps/poker_set/readme.md

@@ -1,6 +1,6 @@
 ### 3  Poker
-[keymap_poker.c](keymap_poker.c) emulates original Poker layers
+[keymap_poker](../poker/readme.md) emulates original Poker layers
-while both [keymap_poker_bit.c](keymap_poker_bit.c) and [keymap_poker_set.c](keymap_poker_set.c) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
+while both [keymap_poker_bit](../poker_bit/readme.md) and [keymap_poker_set](../poker_set/readme.md) implements same layout in different way and they fix a minor issue of original Poker and enhance arrow keys.
 
     Fn + Esc = `
     Fn + {left, down, up, right}  = {home, pgdown, pgup, end}

keyboards/s60_x/keymaps/spacefn/readme.md

@@ -1,5 +1,5 @@
 ### 6. SpaceFN
-This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap_spacefn.c](keymap_spacefn.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
+This layout proposed by spiceBar uses space bar to change layer with using Dual role key technique. See [keymap.c](keymap.c) and [SpaceFN discussion](http://geekhack.org/index.php?topic=51069.0).
 
 #### 6.0 Default layer
     ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐

keyboards/tada68/keymaps/maartenwut/config.h

@@ -1,3 +1 @@
 #include "../../config.h"
-
-#define BACKLIGHT_BREATHING

keyboards/tada68/keymaps/maartenwut/keymap.c

@@ -1,414 +1,82 @@
 #include "tada68.h"
-#include "action_layer.h"
-#include "timer.h"
-#include "bootloader.h"
-#include "command.h"
 
 #define _MA 0
 #define _GA 1
 #define _FL 2
 #define _AR 3
-#define _LO 4
+#define _LE 4
-#define _UL 5
+#define _LO 5
+#define _UL 6
 
 #define TRNS KC_TRNS
 #define trigger_time 400
 
-#define T1 M(1)
-#define T2 M(2)
-#define T3 M(3)
-#define T4 M(4)
-#define T5 M(5)
-#define T6 M(6)
-#define T7 M(7)
-#define T8 M(8)
-#define T9 M(9)
-#define T10 M(10)
-#define T11 M(11)
-#define T12 M(12)
-#define END_HOME M(0)
 #define LSHIFT OSM(MOD_LSFT)
 #define SPACE LT(_AR, KC_SPC)
-
+#define CAPS LT(_LE, KC_CAPS)
-static uint16_t key_timer;
-
-enum emoticons {
-	LENNY = SAFE_RANGE,
-	DWNHRT,
-	SHRUG
-};
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
-  /* Keymap _MA: Main Layer, Default
+// Main Layer
-   * ,----------------------------------------------------------------.
-   * |Esc | 1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |P/P |
-   * |----------------------------------------------------------------| 
-   * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \  |Del |
-   * |----------------------------------------------------------------|
-   * |CAPS   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return |PgUp|
-   * |----------------------------------------------------------------|
-   * |Shft|End|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift | Up|PgDn|
-   * |----------------------------------------------------------------|
-   * |Ctrl|Win |Alt |        Space          |Alt|Ctrl| FN|Lef|Dow|Rig |
-   * `----------------------------------------------------------------'
-   */
 [_MA] = KEYMAP_ANSI(
-  KC_ESC,	T1, 		T2, 		T3, 		T4, 		T5, 		T6, 		T7, 		T8, 		T9, 		T10, 		T11, 		T12,		KC_BSPC,	KC_MPLY, \
+	KC_GESC,	KC_1, 		KC_2, 		KC_3, 		KC_4, 		KC_5, 		KC_6, 		KC_7, 		KC_8, 		KC_9, 		KC_0, 		KC_MINS,	KC_EQL,		KC_BSPC,	KC_MPLY,
-  KC_TAB,	KC_Q, 		KC_W, 		KC_E, 		KC_R, 		KC_T, 		KC_Y, 		KC_U, 		KC_I,  		KC_O,  		KC_P, 		KC_LBRC,	KC_RBRC,	KC_BSLS,	KC_DEL, \
+	KC_TAB,		KC_Q, 		KC_W, 		KC_E, 		KC_R, 		KC_T, 		KC_Y, 		KC_U, 		KC_I,  		KC_O,  		KC_P, 		KC_LBRC,	KC_RBRC,	KC_BSLS,	KC_DEL,
-  KC_CAPS,	KC_A, 		KC_S,   	KC_D, 		KC_F, 		KC_G, 		KC_H, 		KC_J, 		KC_K,  		KC_L,  		KC_SCLN, 	KC_QUOT,  				KC_ENT,		KC_PGUP, \
+	CAPS,		KC_A, 		KC_S,   	KC_D, 		KC_F, 		KC_G, 		KC_H, 		KC_J, 		KC_K,  		KC_L,  		KC_SCLN, 	KC_QUOT,  				KC_ENT,		KC_PGUP,
-  LSHIFT, 	END_HOME,	KC_Z, 		KC_X,   	KC_C, 		KC_V, 		KC_B, 		KC_N, 		KC_M, 		KC_COMM, 	KC_DOT,		KC_SLSH, 	KC_RSFT,    KC_UP,		KC_PGDN, \
+	LSHIFT, 				KC_Z, 		KC_X,   	KC_C, 		KC_V, 		KC_B, 		KC_N, 		KC_M, 		KC_COMM, 	KC_DOT,		KC_SLSH, 	KC_RSFT,    KC_UP,		KC_PGDN,
-  KC_LCTL, 	KC_LGUI, 	KC_LALT,							SPACE,											KC_RALT,	KC_RCTRL, 	MO(_FL),	KC_LEFT, 	KC_DOWN, 	KC_RGHT),
+	KC_LCTL, 	KC_LGUI, 	KC_LALT,							SPACE,											KC_RALT,	KC_RCTRL, 	MO(_FL),	KC_LEFT, 	KC_DOWN, 	KC_RGHT),
-  
+
-  /* Keymap _FL: Function Layer
+//Function Layer
-   * ,----------------------------------------------------------------.
-   * |~` | F1|F2 |F3 |F4 |F5 |F6 |F7 |F8 |F9 |F10|F11|F12|Reset  |Prsc|
-   * |----------------------------------------------------------------|
-   * |     |MbL|MsU|MbR|   |   |   |   |   |   |   |   |   |     |_LO |
-   * |----------------------------------------------------------------|
-   * |      |MsL|MsD|MsR|   |_GA|   |   |   |   |   |   |        |Hme |
-   * |----------------------------------------------------------------|
-   * |    |   |   |   |   |   |   |   |   |VoU|VoD|Mut|      |MwU|End |
-   * |----------------------------------------------------------------|
-   * |    |    |    |                       |   |   |    |MwL|MwD|MwR |  
-   * `----------------------------------------------------------------'
-   */
 [_FL] = KEYMAP_ANSI(
-  KC_GRV,	KC_F1,		KC_F2,  	KC_F3,  	KC_F4,  	KC_F5,		KC_F6,		KC_F7, 		KC_F8,		KC_F9,		KC_F10,  	KC_F11,		KC_F12,		RESET,		KC_PSCR, \
+	KC_GRV,		KC_F1,		KC_F2,  	KC_F3,  	KC_F4,  	KC_F5,		KC_F6,		KC_F7, 		KC_F8,		KC_F9,		KC_F10,  	KC_F11,		KC_F12,		RESET,		KC_PSCR,
-  TRNS, 	KC_BTN1,	KC_MS_U,  	KC_BTN2, 	TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS,		TRNS,		TO(_LO), \
+	TRNS, 		KC_BTN1,	KC_MS_U,  	KC_BTN2, 	TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS,		TRNS,		TO(_LO),
-  TRNS, 	KC_MS_L,	KC_MS_D, 	KC_MS_R,	TRNS,		TG(_GA),	TRNS,		TRNS,		TRNS,		TRNS,		TRNS,		TRNS,					TRNS,		KC_HOME, \
+	TRNS, 		KC_MS_L,	KC_MS_D, 	KC_MS_R,	TRNS,		TG(_GA),	TRNS,		TRNS,		TRNS,		TRNS,		TRNS,		TRNS,					TRNS,		KC_HOME,
-  TRNS, 	TRNS,		TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS,		TRNS,		KC_VOLD,	KC_VOLU,	KC_MUTE,	TRNS,		KC_WH_U,	KC_END, \
+	TRNS, 					TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS,		TRNS,		KC_VOLD,	KC_VOLU,	KC_MUTE,	TRNS,		KC_WH_U,	KC_END,
-  TRNS, 	TRNS, 		TRNS,								TRNS,											TRNS,		TRNS,		TRNS,   	KC_WH_L,	KC_WH_D, 	KC_WH_R),
+	TRNS, 		TRNS, 		TRNS,								TRNS,											TRNS,		TRNS,		TRNS,   	KC_WH_L,	KC_WH_D, 	KC_WH_R),
 
-  /* Keymap _AR: Arrow layer
+//Arrow keys layer (space bar)
-   * ,----------------------------------------------------------------.
-   * |~` | F1|F2 |F3 |F4 |F5 |F6 |F7 |F8 |F9 |F10|F11|F12|       |    |
-   * |----------------------------------------------------------------|
-   * |Lenny|   |   |   |   |   |   |   |   |   |   |   |   |     |    |
-   * |----------------------------------------------------------------|
-   * |Dwnhrt|   |   |   |   |   |Lft|Dwn| Up|Rgt|   |   |        |    |
-   * |----------------------------------------------------------------|
-   * |Shrg|   |   |   |   |   |   |   |   |   |   |   |      |   |    |
-   * |----------------------------------------------------------------|
-   * |    |    |    |                       |   |   |    |   |   |    |
-   * `----------------------------------------------------------------'
-   */
 [_AR] = KEYMAP_ANSI(
- KC_GRV,	KC_F1,		KC_F2,  	KC_F3,  	KC_F4,  	KC_F5,		KC_F6,		KC_F7, 		KC_F8,		KC_F9,		KC_F10,  	KC_F11,		KC_F12,		TRNS,		TRNS, \
+	KC_GRV,		KC_F1,		KC_F2,  	KC_F3,  	KC_F4,  	KC_F5,		KC_F6,		KC_F7, 		KC_F8,		KC_F9,		KC_F10,  	KC_F11,		KC_F12,		TRNS,		TRNS,
-  LENNY,	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,		TRNS, \
+	TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,		TRNS,
-  DWNHRT,	TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS, 		KC_LEFT, 	KC_DOWN, 	KC_UP,  	KC_RGHT,  	TRNS, 		TRNS, 	 				TRNS,		TRNS, \
+	TRNS,		TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS, 		KC_LEFT, 	KC_DOWN, 	KC_UP,  	KC_RGHT,  	TRNS, 		TRNS, 	 				TRNS,		TRNS,
-  SHRUG, 	TRNS,   	TRNS,		TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,   	TRNS,		TRNS, \
+	TRNS,					TERM_ON,	TERM_OFF,	TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,   	TRNS,		TRNS,
-  TRNS, 	TRNS, 		TRNS,								TRNS,											TRNS,		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS),
+	TRNS, 		TRNS, 		TRNS,								TRNS,											TRNS,		TRNS, 		M(0),		TRNS, 		TRNS, 		TRNS),
+//LED control layer (caps)
+[_LE] = KEYMAP_ANSI(
+	TRNS,		TRNS,		TRNS,  		TRNS,  		TRNS,  		TRNS,		TRNS,		TRNS, 		TRNS,		TRNS,		TRNS,  		TRNS,		TRNS,		TRNS,		TRNS,
+	TRNS,		BL_TOGG, 	TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,		TRNS,
+	TRNS,		BL_INC,		TRNS,   	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS, 	 				TRNS,		TRNS,
+	TRNS,					BL_DEC,		TRNS,		TRNS,		TRNS,	 	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,   	TRNS,		TRNS,
+	TRNS, 		TRNS, 		TRNS,								TRNS,											TRNS,		TRNS, 		TRNS,		TRNS, 		TRNS, 		TRNS),
 
-  /* Keymap _GA: Game layer
+//Game layer (fn + g)
-   * ,----------------------------------------------------------------.
-   * |Esc | 1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |P/P |
-   * |----------------------------------------------------------------| 
-   * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \  |Del |
-   * |----------------------------------------------------------------|
-   * |CAPS   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return |PgUp|
-   * |----------------------------------------------------------------|
-   * |Shft|End|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift | Up|PgDn|
-   * |----------------------------------------------------------------|
-   * |Ctrl|Win |Alt |        Space          |Alt|Ctrl| FN|Lef|Dow|Rig |
-   * `----------------------------------------------------------------'
-   */
 [_GA] = KEYMAP_ANSI(
-  KC_ESC,	T1, 		T2, 		T3, 		T4, 		T5, 		T6, 		T7, 		T8, 		T9, 		T10, 		T11, 		T12,		KC_BSPC,	KC_MPLY, \
+	TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS,		TRNS,		TRNS,
-  KC_TAB,	KC_Q, 		KC_W, 		KC_E, 		KC_R, 		KC_T, 		KC_Y, 		KC_U, 		KC_I,  		KC_O,  		KC_P, 		KC_LBRC,	KC_RBRC,	KC_BSLS,	KC_DEL, \
+	TRNS,		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,		TRNS,		TRNS,		TRNS,
-  KC_CAPS,	KC_A, 		KC_S,   	KC_D, 		KC_F, 		KC_G, 		KC_H, 		KC_J, 		KC_K,  		KC_L,  		KC_SCLN, 	KC_QUOT,  				KC_ENT,		KC_PGUP, \
+	KC_CAPS,	TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,  		TRNS,  		TRNS, 		TRNS,  					TRNS,		TRNS,
-  KC_LSFT, 	END_HOME,	KC_Z, 		KC_X,   	KC_C, 		KC_V, 		KC_B, 		KC_N, 		KC_M, 		KC_COMM, 	KC_DOT,		KC_SLSH, 	KC_RSFT,    KC_UP,		KC_PGDN, \
+	KC_LSFT, 				TRNS, 		TRNS,   	TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS, 		TRNS,		TRNS, 		TRNS,		TRNS,		TRNS,
-  KC_LCTL, 	KC_LGUI, 	KC_LALT,							KC_SPC,											KC_RALT,	KC_RCTRL, 	MO(_FL),	KC_LEFT, 	KC_DOWN, 	KC_RGHT),
+	TRNS, 		TRNS, 		TRNS,								KC_SPC,											TRNS,		TRNS, 		MO(_FL),	TRNS, 		TRNS, 		TRNS),
 
-  /* Keymap _UL: Unlock layer
-   * ,----------------------------------------------------------------.
-   * |   |   |   |   |   |   |   |   |   |   |   |   |   |       |    |
-   * |----------------------------------------------------------------|
-   * |     |   |   |   |   |   |   |   |   |   |   |   |   |     |_MA |
-   * |----------------------------------------------------------------|
-   * |      |   |   |   |   |   |   |   |   |   |   |   |        |    |
-   * |----------------------------------------------------------------|
-   * |    |   |   |   |   |   |   |   |   |   |   |   |      |   |    |
-   * |----------------------------------------------------------------|
-   * |    |    |    |                       |   |   |    |   |   |    |
-   * `----------------------------------------------------------------'
-   */
 [_UL] = KEYMAP_ANSI(
-  KC_NO,	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, \
+	KC_NO,		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO,  	KC_NO, 		TO(_MA), \
+	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO,  	KC_NO, 		TO(_MA),
-  KC_NO, 	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 					KC_NO, 		KC_NO, \
+	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 					KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, \
+	KC_NO, 			 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO,    							KC_NO,											KC_NO, 		KC_NO, 		TRNS, 		KC_NO, 		KC_NO, 		KC_NO),
+	KC_NO, 		KC_NO, 		KC_NO,    							KC_NO,											KC_NO, 		KC_NO, 		TRNS, 		KC_NO, 		KC_NO, 		KC_NO),
 
-  /* Keymap _LO: Lock layer
-   * ,----------------------------------------------------------------.
-   * |   |   |   |   |   |   |   |   |   |   |   |   |   |       |    |
-   * |----------------------------------------------------------------|
-   * |     |   |   |   |   |   |   |   |   |   |   |   |   |     |    |
-   * |----------------------------------------------------------------|
-   * |      |   |   |   |   |   |   |   |   |   |   |   |        |    |
-   * |----------------------------------------------------------------|
-   * |    |   |   |   |   |   |   |   |   |   |   |   |      |   |    |
-   * |----------------------------------------------------------------|
-   * |    |    |    |                      |   |   | _UL |   |   |    |
-   * `----------------------------------------------------------------'
-   */
 [_LO] = KEYMAP_ANSI(
-  KC_NO,	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, \
+	KC_NO,		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO,  	KC_NO, 		KC_NO, \
+	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,  	KC_NO, 		KC_NO,  	KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 					KC_NO, 		KC_NO, \
+	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 					KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, \
+	KC_NO, 			 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO, 		KC_NO,
-  KC_NO, 	KC_NO, 		KC_NO,    							KC_NO,											KC_NO, 		KC_NO, 		MO(_UL), 	KC_NO, 		KC_NO, 		KC_NO),
+	KC_NO, 		KC_NO, 		KC_NO,    							KC_NO,											KC_NO, 		KC_NO, 		MO(_UL), 	KC_NO, 		KC_NO, 		KC_NO),
-};
-
-void tap(uint16_t keycode){
-    register_code(keycode);
-    unregister_code(keycode);
-};
-
-bool process_record_user(uint16_t keycode, keyrecord_t *record) {
-	switch (keycode) {
-		case LENNY:			// ( ͡° ͜ʖ ͡°)
-			if(record->event.pressed){
-				set_unicode_input_mode(UC_WIN);
-				register_code(KC_LSFT);
-				tap(KC_9);										// Head
-				unregister_code(KC_LSFT);
-				tap(KC_SPC);									// Space
-				process_unicode((0x0361|QK_UNICODE), record);	// Eyebrow
-				process_unicode((0x00B0|QK_UNICODE), record);	// Eye
-				tap(KC_SPC);
-				process_unicode((0x035C|QK_UNICODE), record);	// Mouth
-				process_unicode((0x0296|QK_UNICODE), record);	// Nose
-				tap(KC_SPC);
-				process_unicode((0x0361|QK_UNICODE), record);	// Eyebrow
-				process_unicode((0x00B0|QK_UNICODE), record);	// Eye
-				register_code(KC_LSFT);
-				tap(KC_0);										// Head
-				unregister_code(KC_LSFT);
-			}
-			return false;
-			break;
-		case DWNHRT:		// (´・ω・`)
-			if(record->event.pressed){
-				set_unicode_input_mode(UC_WIN);
-				register_code(KC_LSFT);
-				tap(KC_9);										// Head
-				unregister_code(KC_LSFT);
-				process_unicode((0x00B4|QK_UNICODE), record);	// Eyebrow
-				process_unicode((0x30FB|QK_UNICODE), record);	// Eye
-				process_unicode((0x03C9|QK_UNICODE), record);	// Mouth
-				process_unicode((0x30FB|QK_UNICODE), record);	// Eye
-				process_unicode((0x0060|QK_UNICODE), record);	// Eyebrow
-				register_code(KC_LSFT);
-				tap(KC_0);										// Head
-				unregister_code(KC_LSFT);
-			}
-			return false;
-			break;
-		case SHRUG:			// ¯\_(ツ)_/¯
-			if(record->event.pressed){
-				set_unicode_input_mode(UC_WIN);
-				process_unicode((0x00AF|QK_UNICODE), record);	// Hand
-				tap(KC_BSLS);									// Arm
-				register_code(KC_LSFT);
-				tap(KC_UNDS);									// Arm
-				tap(KC_LPRN);									// Head
-				unregister_code(KC_LSFT);
-				process_unicode((0x30C4|QK_UNICODE), record);	// Face
-				register_code(KC_LSFT);
-				tap(KC_RPRN);									// Head
-				tap(KC_UNDS);									// Arm
-				unregister_code(KC_LSFT);
-				tap(KC_SLSH);									// Arm
-				process_unicode((0x00AF|QK_UNICODE), record);	// Hand
-			}
-			return false;
-			break;
-	}
-	return true;
 };
 
 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
     switch (id) {
 		case 0:
 			if (record->event.pressed) {
-				key_timer = timer_read();
+				SEND_STRING("Password");
-			}
-			else {
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(END), END );
-				}
-				else {
-					return MACRO( T(HOME), END );
-				}
-			}
-			break;
-		case 1:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F1), END );
-				}
-				else {
-					return MACRO( T(1), END );
-				}
-			}
-			break;
-		case 2:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F2), END );
-				}
-				else {
-					return MACRO( T(2), END );
-				}
-			}
-			break;
-		case 3:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F3), END );
-				}
-				else {
-					return MACRO( T(3), END );
-				}
-			}
-			break;
-		case 4:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F4), END );
-				}
-				else {
-					return MACRO( T(4), END );
-				}
-			}
-			break;
-		case 5:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F5), END );
-				}
-				else {
-					return MACRO( T(5), END );
-				}
-			}
-			break;
-		case 6:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F6), END );
-				}
-				else {
-					return MACRO( T(6), END );
-				}
-			}
-			break;
-		case 7:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F7), END );
-				}
-				else {
-					return MACRO( T(7), END );
-				}
-			}
-			break;
-		case 8:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F8), END );
-				}
-				else {
-					return MACRO( T(8), END );
-				}
-			}
-			break;
-		case 9:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F9), END );
-				}
-				else {
-					return MACRO( T(9), END );
-				}
-			}
-			break;
-		case 10:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F10), END );
-				}
-				else {
-					return MACRO( T(0), END );
-				}
-			}
-			break;
-		case 11:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F11), END );
-				}
-				else {
-					return MACRO( T(MINS), END );
-				}
-			}
-			break;
-		case 12:
-			if (record->event.pressed) {
-				key_timer = timer_read();
-			}
-			else { 
-				if (timer_elapsed(key_timer) > trigger_time) {
-					return MACRO( T(F12), END );
-				}
-				else {
-					return MACRO( T(EQL), END );
-				}
 			}
 			break;
 	}
     return MACRO_NONE;
-};
+};
-
-void led_set_user(uint8_t usb_led) {
-	if (usb_led & (1<<USB_LED_CAPS_LOCK)) {
-        // Turn capslock on
-        PORTB |= (1<<6);
-    } else {
-        // Turn capslock off
-        PORTB &= ~(1<<6);
-    }
-}

keyboards/tada68/keymaps/maartenwut/readme.md

@@ -1,3 +1,3 @@
 # Maartenwut's layout
 
-Well, this is my keyboard layout. You can call it a Tada69 if you want.
+Well, this is Maartenwut's keyboard layout.

keyboards/tada68/keymaps/maartenwut/tada68.h

@@ -1,43 +0,0 @@
-#ifndef TADA68_H
-#define TADA68_H
-
-#include "quantum.h"
-
-// readability
-#define XXX KC_NO
-
-/* TADA68 ANSI layout
-   * ,----------------------------------------------------------------.
-   * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d    | 0e |
-   * |----------------------------------------------------------------|
-   * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d | 1e |
-   * |----------------------------------------------------------------|
-   * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2d    | 2e |
-   * |----------------------------------------------------------------|
-   * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|    3c| 3d| 3e |
-   * |----------------------------------------------------------------|
-   * | 40 | 41 | 42 |        45             | 49| 4a|  4b| 4c| 4d| 4e |
-   * `----------------------------------------------------------------'
- */
-// The first section contains all of the arguments
-// The second converts the arguments into a two-dimensional array
-
-#define KEYMAP_ANSI( \
-    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k0e, \
-	k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, k1e, \
-	k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, k2e, \
-	k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3e, \
-	k40, k41, k42,           k45,                k49, k4a, k4b, k4c, k4d, k4e  \
-) \
-{ \
-	{k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k0e}, \
-	{k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, k1e}, \
-	{k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d, k2e}, \
-	{k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3e}, \
-	{k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d, k4e}  \
-}
-
-void matrix_init_user(void);
-void matrix_scan_user(void);
-
-#endif

keyboards/tada68/readme.md

@@ -5,7 +5,7 @@ A compact 65% keyboard.
 
 Keyboard Maintainer: QMK Community
 Hardware Supported: TADA68 PCB
-Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/products/tada68-mechanical-keyboard-gateron-swtich-65-layout-dye-sub-keycaps-cherry-profils?variant=34710238797) [kbdist](http://www.kbdist.com/shop/saber-68)
+Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/products/tada68-mechanical-keyboard-gateron-swtich-65-layout-dye-sub-keycaps-cherry-profils?variant=34710238797) [kbdist](http://www.kbdist.com/)
 
 Make example for this keyboard (after setting up your build environment):
 

keyboards/tv44/readme.md

@@ -5,7 +5,7 @@ A compact 44% keyboard.
 
 Keyboard Maintainer: QMK Community
 Hardware Supported: The Van PCB
-Hardware Availability: https://thevankeyboards.com/products/minivan-r4-keyboard-kit?variant=37353952718
+Hardware Availability: https://thevankeyboards.com/collections/catalog/products/minivan-diy?variant=609138376718
 
 Make example for this keyboard (after setting up your build environment):
 

keyboards/xd75/keymaps/skewwhiffy/keymap.c

@@ -22,13 +22,11 @@
 
 // Layer shorthand
 #define _CM 0 // Colemak
-#define _QW 1 // Qwerty
+#define _NB 1 // Numbers
-#define _DV 2 // Dvorak
+#define _FN 2 // Function
-#define _NB 3 // Numbers
+#define _SYL 3 // Symbols left
-#define _FN 4 // Function
+#define _SYR 4 // Symbols right
-#define _SYL 5 // Symbols left
+#define _NAV 5 // Navigation
-#define _SYR 6 // Symbols right
-#define _NAV 7 // Navigation
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
@@ -42,15 +40,15 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * |--------+--------------+--------------+---------------+--------------+--------------+--------+--------+--------+----------------+--------+------------------+----------------+------------------------|
  * |        | sft or Z     | nb or X      | sym or C      | V            | nav or B     |        |        |        | nav or K       | M      | sym or ,         | nb or .        | sft or /      |        |
  * |--------+--------------+--------------+---------------+--------------+--------------+--------+--------+--------+----------------+--------+------------------+----------------+------------------------|
- * | LSHIFT | LCTRL        |   LALT       | LGUI          |              | SPACE        | LCTRL  | DEL    | LALT   | BACKSP         |        | RGUI             | RALT           | RCTRL         | RSHIFT |
+ * | LSHIFT | LCTRL        |   LALT       | LGUI          | CTRL '       | SPACE        | LCTRL  | DEL    | LALT   | BACKSP         | RGUI   | RGUI             | RALT           | RCTRL         | RSHIFT |
  * '------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------'
- */	
+ */
  [_CM] = {
   { _______, _______,       _______,       _______,        _______,       _______,        _______, _______, _______, _______,        _______, _______,           _______,          _______,        _______ },
   { _______, KC_Q,          KC_W,          KC_F,           KC_P,          KC_G,           _______, _______, _______, KC_J,           KC_L,    KC_U,              KC_Y,             KC_SCLN,        _______ },
   { _______, KC_A,          KC_R,          KC_S,           KC_T,          KC_D,           _______, _______, _______, KC_H,           KC_N,    KC_E,              KC_I,             KC_O,           KC_ENT  },
   { _______, SFT_T(KC_Z),   LT(_NB, KC_X), LT(_SYL, KC_C), KC_V,          LT(_NAV, KC_B), _______, _______, _______, LT(_NAV, KC_K), KC_M,    LT(_SYR, KC_COMM), LT(_FN, KC_DOT),  SFT_T(KC_SLSH), _______ },
-  { KC_LSFT, KC_LCTL,       KC_LALT,       KC_LGUI,        LCTL(KC_QUOT), KC_SPC,         KC_LCTL, KC_DEL , KC_LALT, KC_BSPC,        _______, KC_RGUI,           KC_RALT,          KC_RCTL,        KC_RSFT },
+  { KC_LSFT, KC_LCTL,       KC_LALT,       KC_LGUI,        LCTL(KC_QUOT), KC_SPC,         KC_LCTL, KC_DEL , KC_LALT, KC_BSPC,        KC_RGUI, KC_RGUI,           KC_RALT,          KC_RCTL,        KC_RSFT },
  },
 
 /* Numbers _NB / Functions _FN
@@ -93,14 +91,14 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * |--------+--------+--------+---------------+--------+--------+--------+--------+--------+--------+--------+------------------+--------+--------+--------|
  * |        |        |        |               |        |        |        |        |        |        |        |                  |        |        |        |
  * '-------------------------------------------------------------------------------------------------------------------------------------------------------'
- */ 
+ */
  [_SYL] = {
   { _______, _______, _______, _______,        _______, _______, _______, _______, _______, _______, _______, _______,           _______, _______, _______  },
   { _______, KC_EXLM, UK_PND,  KC_UNDS,        KC_MINS, KC_TILD, _______, _______, _______, UK_BSLS, KC_LCBR, KC_RCBR,           KC_SLSH, UK_HASH, _______  },
   { _______, KC_DLR,  KC_PERC, KC_PLUS,        KC_EQL,  _______, _______, _______, _______, UK_QUOT, KC_LPRN, KC_RPRN,           KC_QUOT, UK_AT,   _______  },
   { _______, KC_CIRC, KC_AMPR, LT(_SYL, KC_C), UK_PIPE, _______, _______, _______, _______, KC_LABK, KC_LBRC, KC_RBRC,           KC_RABK, KC_GRV,  _______  },
   { _______, _______, _______, _______,        _______, _______, _______, _______, _______, _______, _______, _______,           _______, _______, _______  },
- }, 
+ },
  [_SYR] = {
   { _______, _______, _______, _______,        _______, _______, _______, _______, _______, _______, _______, _______,           _______, _______, _______  },
   { _______, KC_EXLM, UK_PND,  KC_UNDS,        KC_MINS, KC_TILD, _______, _______, _______, KC_BSLS, KC_LCBR, KC_RCBR,           KC_SLSH, UK_HASH, _______  },

layouts/community/ergodox/ab/readme.md

@@ -8,7 +8,7 @@ Beginner's keymap emulates standard QWERTY keyboard for beginners. Once you get
 * Easy on beginners. It has everything you need for your day to day usage.
 
 #### Cons
-* Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/ergodox/keymaps/default/readme.md)
+* Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/qmk/qmk_firmware/blob/master/layouts/default/ergodox/default_ergodox/keymap.c)
 * While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys.
 
 #### Notes

layouts/community/ergodox/belak/README.md

@@ -1,8 +1,8 @@
 # Belak's Ergodox Layout
 
-This has been based off of [emacs\_osx\_dk](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/emacs_osx_dk)
+This has been based off of [emacs\_osx\_dk](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ergodox/emacs_osx_dk)
 from the main qmk repo. However, I've taken some of the ideas for the thumbs
-from [dvorak\_emacs](https://github.com/jackhumbert/qmk_firmware/tree/master/keyboards/ergodox/keymaps/dvorak_emacs)
+from [dvorak\_emacs](https://github.com/qmk/qmk_firmware/tree/master/layouts/community/ergodox/dvorak_emacs)
 and tweaked it a bit based on the keycaps I have.
 
 This keyboard is intended for use in emacs (one of the main reasons for easy

layouts/community/ergodox/familiar/README.md

@@ -1,7 +1,7 @@
 # ErgoDox Familiar Layout
 Familiar layout for those who regularly switch back and forth from ErgoDox to "normal" QWERTY.
 
-[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](../../../../license_GPLv3.md../../../../license_GPLv3.md) [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
+[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](../../../../license_GPLv3.md) [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
 
 ## Table of Contents
 
@@ -66,4 +66,4 @@ I'm terrible at this; I have no background in human-computer interaction, kinesi
 1. `MENU` and `LEAD` are useless, at the moment.
 
 ## License
-QMK is licensed ([mostly](https://github.com/qmk/qmk_firmware/issues/1038)) under the [GPLv2](blob/master/license_GPLv2.md). Accordingly, to whatever extent applicable, this keymap is licensed under the [GPLv3](../../../../license_GPLv3.md).
+QMK is licensed ([mostly](https://github.com/qmk/qmk_firmware/issues/1038)) under the [GPLv2](../../../../license_GPLv2.md). Accordingly, to whatever extent applicable, this keymap is licensed under the [GPLv3](../../../../license_GPLv3.md).

layouts/community/ergodox/ordinary/readme.md

@@ -98,4 +98,4 @@ No rights reserved. This software is in the public domain. Credit me if you are
 Keyboard layout images were created with http://www.keyboard-layout-editor.com/ by Ian Prest my thanks to that free service
 
 Details: readme.md
-         https://github.com/nrrkeene/qmk_firmware/tree/master/keyboards/ergodox/keymaps/ordinary
+         https://github.com/nrrkeene/qmk_firmware/tree/master/layouts/community/ergodox/ordinary

layouts/community/ergodox/qwerty_code_friendly/keymap.c

@@ -1,3 +1,5 @@
+/* -*- Mode:C; c-basic-offset:2; tab-width:2; indent-tabs-mode:nil; evil-indent-convert-tabs:t; -*- */
+
 #include QMK_KEYBOARD_H
 #include "debug.h"
 #include "action_layer.h"
@@ -7,51 +9,153 @@
  * See `readme.md` for notes on each define.
  */
 
-// Personal preference (enable by passing EXTRAFLAGS=... to make).
+/* Personal preference (enable by passing EXTRAFLAGS=... to make). */
-// #define CFQ_USE_MOMENTARY_LAYER_KEYS
+/* #define CFQ_USE_MOMENTARY_LAYER_KEYS */
-// #define CFQ_USE_EXPEREMENTAL_LAYER
 
-// keep enabled for now
 #define CFQ_USE_DYNAMIC_MACRO
 
+#if !defined(CFQ_USER_KEY0)
+#  define CFQ_USER_KEY0 KC_BSPC
+#endif
 #if !defined(CFQ_USER_KEY1)
 #  define CFQ_USER_KEY1 CFQ_KC_FN1
 #endif
 #if !defined(CFQ_USER_KEY2)
-#  define CFQ_USER_KEY2 KC_INS
+#  define CFQ_USER_KEY2 KC_LT
 #endif
 #if !defined(CFQ_USER_KEY3)
-#  ifdef CFQ_USE_EXPEREMENTAL_LAYER
+#  define CFQ_USER_KEY3 KC_GT
-#    define CFQ_USER_KEY3 CFQ_KC_FN3
-#  else
-#    define CFQ_USER_KEY3 KC_CAPS
-#  endif
 #endif
 #if !defined(CFQ_USER_KEY4)
-#  define CFQ_USER_KEY4 KC_SPC
+#  define CFQ_USER_KEY4 KC_BSPC
 #endif
 #if !defined(CFQ_USER_KEY5)
-#  define CFQ_USER_KEY5 KC_ENT
+#  define CFQ_USER_KEY5 KC_DELT
 #endif
 #if !defined(CFQ_USER_KEY6)
-#  define CFQ_USER_KEY6 CFQ_KC_FN2
+#  define CFQ_USER_KEY6 KC_CAPS
 #endif
 #if !defined(CFQ_USER_KEY7)
-#  define CFQ_USER_KEY7 CFQ_KC_FN1
+#  define CFQ_USER_KEY7 CFQ_KC_FN3
 #endif
 
-#define BASE 0 // default layer
+#ifndef CFQ_WORD_A
-#define SYMB 1 // symbols
+#define CFQ_WORD_A ""
-#define MDIA 2 // media keys
-#ifdef CFQ_USE_EXPEREMENTAL_LAYER
-#  define EXPR 3 // experimental keys
 #endif
+#ifndef CFQ_WORD_B
+#define CFQ_WORD_B ""
+#endif
+#ifndef CFQ_WORD_C
+#define CFQ_WORD_C ""
+#endif
+#ifndef CFQ_WORD_D
+#define CFQ_WORD_D ""
+#endif
+#ifndef CFQ_WORD_E
+#define CFQ_WORD_E ""
+#endif
+#ifndef CFQ_WORD_F
+#define CFQ_WORD_F ""
+#endif
+#ifndef CFQ_WORD_G
+#define CFQ_WORD_G ""
+#endif
+#ifndef CFQ_WORD_H
+#define CFQ_WORD_H ""
+#endif
+#ifndef CFQ_WORD_I
+#define CFQ_WORD_I ""
+#endif
+#ifndef CFQ_WORD_J
+#define CFQ_WORD_J ""
+#endif
+#ifndef CFQ_WORD_K
+#define CFQ_WORD_K ""
+#endif
+#ifndef CFQ_WORD_L
+#define CFQ_WORD_L ""
+#endif
+#ifndef CFQ_WORD_M
+#define CFQ_WORD_M ""
+#endif
+#ifndef CFQ_WORD_N
+#define CFQ_WORD_N ""
+#endif
+#ifndef CFQ_WORD_O
+#define CFQ_WORD_O ""
+#endif
+#ifndef CFQ_WORD_P
+#define CFQ_WORD_P ""
+#endif
+#ifndef CFQ_WORD_Q
+#define CFQ_WORD_Q ""
+#endif
+#ifndef CFQ_WORD_R
+#define CFQ_WORD_R ""
+#endif
+#ifndef CFQ_WORD_S
+#define CFQ_WORD_S ""
+#endif
+#ifndef CFQ_WORD_T
+#define CFQ_WORD_T ""
+#endif
+#ifndef CFQ_WORD_U
+#define CFQ_WORD_U ""
+#endif
+#ifndef CFQ_WORD_V
+#define CFQ_WORD_V ""
+#endif
+#ifndef CFQ_WORD_W
+#define CFQ_WORD_W ""
+#endif
+#ifndef CFQ_WORD_X
+#define CFQ_WORD_X ""
+#endif
+#ifndef CFQ_WORD_Y
+#define CFQ_WORD_Y ""
+#endif
+#ifndef CFQ_WORD_Z
+#define CFQ_WORD_Z ""
+#endif
+
+static const char *cfq_word_lut[26] = {
+  CFQ_WORD_A, CFQ_WORD_B, CFQ_WORD_C, CFQ_WORD_D, CFQ_WORD_E, CFQ_WORD_F,
+  CFQ_WORD_G, CFQ_WORD_H, CFQ_WORD_I, CFQ_WORD_J, CFQ_WORD_K, CFQ_WORD_L,
+  CFQ_WORD_M, CFQ_WORD_N, CFQ_WORD_O, CFQ_WORD_P, CFQ_WORD_Q, CFQ_WORD_R,
+  CFQ_WORD_S, CFQ_WORD_T, CFQ_WORD_U, CFQ_WORD_V, CFQ_WORD_W, CFQ_WORD_X,
+  CFQ_WORD_Y, CFQ_WORD_Z,
+};
+
+#define BASE 0 /* default layer */
+#define SYMB 1 /* symbols */
+#define MDIA 2 /* media keys */
+#define WORD 3 /* experimental keys */
 
 enum custom_keycodes {
-  PLACEHOLDER = SAFE_RANGE, // can always be here
+  PLACEHOLDER = SAFE_RANGE, /* can always be here */
-  EPRM,
-  VRSN,
   RGB_SLD,
+
+  M_BRACKET_IN_CBR,
+  M_BRACKET_IN_PRN,
+  M_BRACKET_IN_BRC,
+  M_BRACKET_IN_ANG,
+  M_BRACKET_OUT_CBR,
+  M_BRACKET_OUT_PRN,
+  M_BRACKET_OUT_BRC,
+  M_BRACKET_OUT_ANG,
+  M_ARROW_RMINUS,
+  M_ARROW_LMINUS,
+  M_ARROW_REQL,
+  M_ARROW_LEQL,
+
+  /* allow user defined words for each character:
+   * use CFQ_WORD_[A-Z] defines. */
+  M_WORD_A, M_WORD_B, M_WORD_C, M_WORD_D, M_WORD_E, M_WORD_F,
+  M_WORD_G, M_WORD_H, M_WORD_I, M_WORD_J, M_WORD_K, M_WORD_L,
+  M_WORD_M, M_WORD_N, M_WORD_O, M_WORD_P, M_WORD_Q, M_WORD_R,
+  M_WORD_S, M_WORD_T, M_WORD_U, M_WORD_V, M_WORD_W, M_WORD_X,
+  M_WORD_Y, M_WORD_Z,
+
 #ifdef CFQ_USE_DYNAMIC_MACRO
   DYNAMIC_MACRO_RANGE,
 #endif
@@ -61,30 +165,6 @@ enum custom_keycodes {
 #include "dynamic_macro.h"
 #endif
 
-// macros
-#ifdef CFQ_USE_EXPEREMENTAL_LAYER
-#define M_SPACES_1 2
-#define M_SPACES_2 3
-#define M_SPACES_3 4
-#define M_SPACES_4 5
-#define M_SPACES_5 6
-#define M_SPACES_6 7
-#define M_SPACES_7 8
-#define M_SPACES_8 9
-#endif
-#define M_BRACKET_IN_CBR 10
-#define M_BRACKET_IN_PRN 11
-#define M_BRACKET_IN_BRC 12
-#define M_BRACKET_IN_ANG 13
-#define M_BRACKET_OUT_CBR 14
-#define M_BRACKET_OUT_PRN 15
-#define M_BRACKET_OUT_BRC 16
-#define M_BRACKET_OUT_ANG 17
-#define M_ARROW_RMINUS 18
-#define M_ARROW_LMINUS 19
-#define M_ARROW_REQL 20
-#define M_ARROW_LEQL 21
-
 #ifdef CFQ_USE_MOMENTARY_LAYER_KEYS
 #define CFQ_KC_FN1 MO(1)
 #define CFQ_KC_FN2 MO(2)
@@ -99,42 +179,49 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 /* Keymap 0: Basic layer
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
- * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
  * | Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |           |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * | Esc    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
  * |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
  * | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
- *   | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Del  |
+ *   | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Ins  |
  *   `----------------------------------'                                       `----------------------------------'
  *                                        ,-------------.       ,-------------.
- *                                        | Ins  |CapsLk|       | Home | End  |
+ *                                        |   <  |  >   |       | Home | End  |
- *                                 ,------|------|------|       |------+------+------.
+ *                                 ,------+------+------|       |------+------+------.
- *                                 |      |      | ~L2  |       | PgUp |      |      |
+ *                                 |      |      |CapsLk|       | PgUp |      |      |
- *                                 |Space |Enter |------|       |------|Enter |Space |
+ *                                 |BSpace| Del  |------|       |------| ~L2  |Space |
- *                                 |      |      | ~L1  |       | PgDn |      |      |
+ *                                 |      |      | ~L3  |       | PgDn |      |      |
  *                                 `--------------------'       `--------------------'
  *
  * Optional overrides: see CFQ_USER_KEY# defines.
  *
- *   -------+------+------+------+------+
+ * ,--------------------------------------------------.           ,--------------------------------------------------.
- *   |      |      |      | USR1 |      |
+ * |        |      |      |      |      |      |      |           |      |      |      |      |      |      | USR0   |
- *   `----------------------------------'
+ * |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
- *
+ * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
- *                                        ,-------------.
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- *                                        | USR2 | USR3 |
+ * |        |      |      |      |      |      |------|           |------|      |      |      |      |      |        |
- *                                 ,------|------|------|
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- *                                 |      |      | USR6 |
+ * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
- *                                 | USR4 | USR5 |------|
+ * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
- *                                 |      |      | USR7 |
+ *   |      |      |      | USR1 |      |                                       |      |      |      |      |      |
- *                                 `--------------------'
+ *   `----------------------------------'                                       `----------------------------------'
+ *                                        ,-------------.       ,-------------.
+ *                                        | USR2 | USR3 |       |      |      |
+ *                                 ,------+------+------|       |------+------+------.
+ *                                 |      |      | USR6 |       |      |      |      |
+ *                                 | USR4 | USR5 |------|       |------|      |      |
+ *                                 |      |      | USR7 |       |      |      |      |
+ *                                 `--------------------'       `--------------------'
  */
 
-// If it accepts an argument (i.e, is a function), it doesn't need KC_.
+/* If it accepts an argument (i.e, is a function), it doesn't need KC_.
-// Otherwise, it needs KC_*
+ * Otherwise, it needs KC_* */
-[BASE] = LAYOUT_ergodox(  // layer 0 : default
+[BASE] = LAYOUT_ergodox(  /* layer 0 : default */
-  // left hand
+  /* left hand */
   KC_GRV,  KC_EXLM, KC_AT,   KC_HASH,       KC_DLR, KC_PERC, KC_LCBR,
   KC_TAB,  KC_Q,    KC_W,    KC_E,          KC_R,   KC_T,    KC_LPRN,
   KC_ESC,  KC_A,    KC_S,    KC_D,          KC_F,   KC_G,
@@ -143,48 +230,43 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                                                     CFQ_USER_KEY2, CFQ_USER_KEY3,
                                                                    CFQ_USER_KEY6,
                                      CFQ_USER_KEY4, CFQ_USER_KEY5, CFQ_USER_KEY7,
-  // right hand
+  /* right hand */
-  KC_RCBR,     KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL,    KC_BSPC,
+  KC_RCBR,     KC_CIRC, KC_AMPR, KC_ASTR,KC_MINS, KC_EQL,    CFQ_USER_KEY0,
   KC_RPRN,     KC_Y,    KC_U,    KC_I,   KC_O,    KC_P,      KC_BSLS,
                KC_H,    KC_J,    KC_K,   KC_L,    KC_SCLN,   KC_QUOT,
   KC_RBRC,     KC_N,    KC_M,    KC_COMM,KC_DOT,  KC_SLSH,   KC_RSFT,
-                        KC_LEFT, KC_DOWN,KC_UP,   KC_RGHT,   KC_DELT,
+                        KC_LEFT, KC_DOWN,KC_UP,   KC_RGHT,   KC_INS,
   KC_HOME, KC_END,
   KC_PGUP,
-#ifdef CFQ_USE_SWAP_RIGHT_SPACE_ENTER
+  KC_PGDN, CFQ_KC_FN2, KC_ENT
-  KC_PGDN, KC_SPC, KC_ENT
+),/* Keymap 1: KeyPad, Macro Record
-#else
-  KC_PGDN, KC_ENT, KC_SPC
-#endif
-),
-/* Keymap 1: Symbol layer
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
- * |        |  F1  |  F2  |  F3  |  F4  |  F5  |  {}  |           |  }{  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
+ * |        |      |      |      |      |      |  {}  |           |  }{  |      |NumLck|   /  |   *  |   -  |        |
- * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
- * |        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   \  |   F11  |
+ * |        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   +  |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   *  |   F12  |
+ * |        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   +  |        |
  * |--------+------+------+------+------+------|  []  |           |  ][  |------+------+------+------+------+--------|
- * |        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  |   -  |        |
+ * |        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  | Enter|        |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
- *   |      |      |      |      |      |                                       |   0  |      |   .  |   +  |      |
+ *   |      |      |      |      |      |                                       |   0  |      |   .  | Enter|      |
  *   `----------------------------------'                                       `----------------------------------'
- *                                        ,-------------.       ,---------------.
+ *                                        ,-------------.       ,--------------.
- *                                        |Start1|Start2|       |      |        |
+ *                                        |Start1|Start2|       |      |       |
- *                                 ,------|------|------|       |------+--------+------.
+ *                                 ,------+------+------|       |------+-------+------.
- *                                 |      |      | Stop |       |      |        |      |
+ *                                 |      |      | Stop |       |      |       |      |
- *                                 |Play1 |Play2 |------|       |------|        |      |
+ *                                 |Play1 |Play2 |------|       |------|       |      |
- *                                 |      |      |      |       |      |        |      |
+ *                                 |      |      |      |       |      |       |      |
- *                                 `--------------------'       `----------------------'
+ *                                 `--------------------'       `---------------------'
  */
-// SYMBOLS
+/* SYMBOLS */
 [SYMB] = LAYOUT_ergodox(
-  // left hand
+  /* left hand */
-  KC_TRNS, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,               M(M_BRACKET_IN_CBR),
+  KC_TRNS, KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,            M_BRACKET_IN_CBR,
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_REQL),     M(M_BRACKET_IN_PRN),
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_ARROW_REQL,     M_BRACKET_IN_PRN,
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_ARROW_RMINUS),
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_ARROW_RMINUS,
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M(M_BRACKET_IN_ANG), M(M_BRACKET_IN_BRC),
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, M_BRACKET_IN_ANG, M_BRACKET_IN_BRC,
   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
 #ifdef CFQ_USE_DYNAMIC_MACRO
                                DYN_REC_START1, DYN_REC_START2,
@@ -195,21 +277,21 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
                                                KC_TRNS,
                              KC_TRNS, KC_TRNS, KC_TRNS,
 #endif
-  // right hand
+  /* right hand */
-  M(M_BRACKET_OUT_CBR), KC_F6,                KC_F7,   KC_F8,   KC_F9,     KC_F10,         KC_TRNS,
+  M_BRACKET_OUT_CBR, KC_TRNS,           KC_NLCK, KC_KP_SLASH, KC_KP_ASTERISK, KC_KP_MINUS,  KC_TRNS,
-  M(M_BRACKET_OUT_PRN), M(M_ARROW_LEQL),      KC_KP_7, KC_KP_8, KC_KP_9,   KC_KP_SLASH,    KC_F11,
+  M_BRACKET_OUT_PRN, M_ARROW_LEQL,      KC_KP_7, KC_KP_8,     KC_KP_9,        KC_KP_PLUS,  KC_TRNS,
-                        M(M_ARROW_LMINUS),    KC_KP_4, KC_KP_5, KC_KP_6,   KC_KP_ASTERISK, KC_F12,
+                     M_ARROW_LMINUS,    KC_KP_4, KC_KP_5,     KC_KP_6,        KC_KP_PLUS,  KC_TRNS,
-  M(M_BRACKET_OUT_BRC), M(M_BRACKET_OUT_ANG), KC_KP_1, KC_KP_2, KC_KP_3,   KC_KP_MINUS,    KC_TRNS,
+  M_BRACKET_OUT_BRC, M_BRACKET_OUT_ANG, KC_KP_1, KC_KP_2,     KC_KP_3,        KC_KP_ENTER, KC_TRNS,
-                                              KC_KP_0, KC_TRNS, KC_KP_DOT, KC_KP_PLUS,     KC_TRNS,
+                                        KC_KP_0, KC_TRNS,     KC_KP_DOT,      KC_KP_ENTER, KC_TRNS,
   KC_TRNS, KC_TRNS,
   KC_TRNS,
   KC_TRNS, KC_TRNS, KC_TRNS
 ),
-/* Keymap 2: Media and mouse keys
+/* Keymap 2: F-Keys, media and mouse keys
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
  * |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
- * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
  * |        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
  * |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
@@ -220,15 +302,15 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  *   `----------------------------------'                                       `----------------------------------'
  *                                        ,-------------.       ,-------------.
  *                                        | MRwd | MFwd |       | MPrv | MNxt |
- *                                 ,------|------|------|       |------+------+------.
+ *                                 ,------+------+------|       |------+------+------.
  *                                 |      |      |      |       |VolUp |      |      |
- *                                 |      |      |------|       |------| Mute | Play |
+ *                                 | Mute |      |------|       |------|      | Play |
  *                                 |      |      |      |       |VolDn |      |      |
  *                                 `--------------------'       `--------------------'
  */
-// MEDIA AND MOUSE
+/* MEDIA AND MOUSE */
 [MDIA] = LAYOUT_ergodox(
-  // left hand
+  /* left hand */
   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
   KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_WH_U,
   KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
@@ -236,131 +318,66 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
                                       KC_MRWD, KC_MFFD,
                                                KC_TRNS,
-                             KC_TRNS, KC_TRNS, KC_TRNS,
+                             KC_MUTE, KC_TRNS, KC_TRNS,
-  // right hand
+  /* right hand */
-  KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+  KC_TRNS, KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
   KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
             KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, KC_TRNS, KC_TRNS,
   KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
                      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
   KC_MPRV, KC_MNXT,
   KC_VOLU,
-  KC_VOLD, KC_MUTE, KC_MPLY
+  KC_VOLD, KC_TRNS, KC_MPLY
 ),
-#ifdef CFQ_USE_EXPEREMENTAL_LAYER
+/* Keymap 3: Entire Words (one for each key)
-/* Keymap 3: My own testing keys!
  *
  * ,--------------------------------------------------.           ,--------------------------------------------------.
- * |        |      |      |  {   |   }  |      |   }  |           |      |      |      |      |      |      |        |
+ * |        |  F1  |  F2  |  F3  |  F4  |  F5  |  F11 |           | F12  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
- * |--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
- * |        |      |      |  (   |   )  |      |   )  |           |      | Spc7 | Spc8 |      |      |      |        |
+ * |        |   Q  |   W  |   E  |   R  |   T  |      |           |      |   Y  |   U  |   I  |   O  |   P  |        |
  * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |        |      |      |  [   |   ]  |      |------|           |------| Spc4 | Spc5 | Spc6 |      |      |        |
+ * |        |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |      |        |
- * |--------+------+------+------+------+------|   ]  |           |      |------+------+------+------+------+--------|
+ * |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
- * |        |      |      |  <   |   >  |      |      |           |      | Spc1 | Spc2 | Spc3 |      |      |        |
+ * |        |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |      |      |      |        |
  * `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
  *   |      |      |      |      |      |                                       |      |      |      |      |      |
  *   `----------------------------------'                                       `----------------------------------'
  *                                        ,-------------.       ,-------------.
  *                                        |      |      |       |      |      |
- *                                 ,------|------|------|       |------+------+------.
+ *                                 ,------+------+------|       |------+------+------.
  *                                 |      |      |      |       |      |      |      |
  *                                 |      |      |------|       |------|      |      |
  *                                 |      |      |      |       |      |      |      |
  *                                 `--------------------'       `--------------------'
  */
 
-// EXPERIMENT
+/* WORDS */
-[EXPR] = LAYOUT_ergodox(
+[WORD] = LAYOUT_ergodox(
-  // left hand
+  /* left hand */
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_LCBR,    KC_RCBR,    KC_TRNS, KC_RCBR,
+  KC_TRNS, KC_F1,    KC_F2,    KC_F3,    KC_F4,    KC_F5,    KC_F11,
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_LPRN,    KC_RPRN,    KC_TRNS, KC_RPRN,
+  KC_TRNS, M_WORD_Q, M_WORD_W, M_WORD_E, M_WORD_R, M_WORD_T, KC_TRNS,
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_LBRC,    KC_RBRC,	 KC_TRNS,
+  KC_TRNS, M_WORD_A, M_WORD_S, M_WORD_D, M_WORD_F, M_WORD_G,
-  KC_TRNS, KC_TRNS, KC_TRNS, S(KC_COMM), S(KC_DOT),  KC_TRNS, KC_RBRC,
+  KC_TRNS, M_WORD_Z, M_WORD_X, M_WORD_C, M_WORD_V, M_WORD_B, KC_TRNS,
-  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,    KC_TRNS,
+  KC_TRNS, KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
-                                         KC_TRNS, KC_TRNS,
+                                                   KC_TRNS,  KC_TRNS,
-                                                  KC_TRNS,
+                                                             KC_TRNS,
-                                KC_TRNS, KC_TRNS, KC_TRNS,
+                                         KC_TRNS,  KC_TRNS,  KC_TRNS,
-  // right hand
+  /* right hand */
-  KC_TRNS, KC_TRNS, KC_TRNS,       KC_TRNS,       KC_TRNS,       KC_TRNS, KC_TRNS,
+  KC_F12,  KC_F6,    KC_F7,    KC_F8,    KC_F9,    KC_F10,   KC_TRNS,
-  KC_TRNS, KC_TRNS, M(M_SPACES_7), M(M_SPACES_8), KC_TRNS,       KC_TRNS, KC_TRNS,
+  KC_TRNS, M_WORD_Y, M_WORD_U, M_WORD_I, M_WORD_O, M_WORD_P, KC_TRNS,
-           KC_TRNS, M(M_SPACES_4), M(M_SPACES_5), M(M_SPACES_6), KC_TRNS, KC_TRNS,
+           M_WORD_H, M_WORD_J, M_WORD_K, M_WORD_L, KC_TRNS,  KC_TRNS,
-  KC_TRNS, KC_TRNS, M(M_SPACES_1), M(M_SPACES_2), M(M_SPACES_3), KC_TRNS, KC_TRNS,
+  KC_TRNS, M_WORD_N, M_WORD_M, KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
-  KC_TRNS, KC_TRNS, KC_TRNS,       KC_TRNS,       KC_TRNS,
+                     KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,  KC_TRNS,
   KC_TRNS, KC_TRNS,
   KC_TRNS,
   KC_TRNS, KC_TRNS, KC_TRNS
 ),
-#endif // CFQ_USE_EXPEREMENTAL_LAYER
 };
 
 const uint16_t PROGMEM fn_actions[] = {
-  [1] = ACTION_LAYER_TAP_TOGGLE(SYMB),               // FN1 - Momentary Layer 1 (Symbols)
+  [1] = ACTION_LAYER_TAP_TOGGLE(SYMB),               /* FN1 - Momentary Layer 1 (Symbols) */
-  [2] = ACTION_LAYER_TAP_TOGGLE(MDIA),               // FN2 - Momentary Layer 2 (Media)
+  [2] = ACTION_LAYER_TAP_TOGGLE(MDIA),               /* FN2 - Momentary Layer 2 (Media) */
-#ifdef CFQ_USE_EXPEREMENTAL_LAYER
+  [3] = ACTION_LAYER_TAP_TOGGLE(WORD),               /* FN3 - Momentary Layer 3 (Words) */
-  [3] = ACTION_LAYER_TAP_TOGGLE(EXPR),               // FN3 - Momentary Layer 3 (Expremental)
-#endif
-};
-
-const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
-{
-  // MACRODOWN only works in this function
-  switch(id) {
-    case 0:
-    if (record->event.pressed) {
-      SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
-    }
-    break;
-    case 1:
-    if (record->event.pressed) { // For resetting EEPROM
-      eeconfig_init();
-    }
-    break;
-#ifdef CFQ_USE_EXPEREMENTAL_LAYER
-    case M_SPACES_1:
-      if (record->event.pressed) { return MACRO(T(SPC), END); }
-    case M_SPACES_2:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), END); }
-    case M_SPACES_3:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), END); }
-    case M_SPACES_4:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), END); }
-    case M_SPACES_5:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
-    case M_SPACES_6:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
-    case M_SPACES_7:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
-    case M_SPACES_8:
-      if (record->event.pressed) { return MACRO(T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), T(SPC), END); }
-#endif // CFQ_USE_EXPEREMENTAL_LAYER
-    case M_BRACKET_IN_CBR: // {}
-      if (record->event.pressed) { return MACRO(D(LSFT), T(LBRC), T(RBRC), U(LSFT), T(LEFT), END); }
-    case M_BRACKET_IN_PRN: // ()
-      if (record->event.pressed) { return MACRO(D(LSFT), T(9), T(0), U(LSFT), T(LEFT), END); }
-    case M_BRACKET_IN_BRC: // []
-      if (record->event.pressed) { return MACRO(T(LBRC), T(RBRC), T(LEFT), END); }
-    case M_BRACKET_IN_ANG: // <>
-      if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), T(DOT), U(LSFT), T(LEFT), END); }
-    case M_BRACKET_OUT_CBR: // }{
-      if (record->event.pressed) { return MACRO(D(LSFT), T(RBRC), T(LBRC), U(LSFT), T(LEFT), END); }
-    case M_BRACKET_OUT_PRN: // )(
-      if (record->event.pressed) { return MACRO(D(LSFT), T(0), T(9), U(LSFT), T(LEFT), END); }
-    case M_BRACKET_OUT_BRC: // ][
-      if (record->event.pressed) { return MACRO(T(RBRC), T(LBRC), T(LEFT), END); }
-    case M_BRACKET_OUT_ANG: // ><
-      if (record->event.pressed) { return MACRO(D(LSFT), T(DOT), T(COMM), U(LSFT), T(LEFT), END); }
-
-    case M_ARROW_RMINUS:
-      if (record->event.pressed) { return MACRO(T(MINUS), D(LSFT), T(DOT), U(LSFT), END); }
-    case M_ARROW_LMINUS:
-      if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(MINUS), END); }
-    case M_ARROW_REQL:
-      if (record->event.pressed) { return MACRO(T(EQL), D(LSFT), T(DOT), U(LSFT), END); }
-    case M_ARROW_LEQL:
-      if (record->event.pressed) { return MACRO(D(LSFT), T(COMM), U(LSFT), T(EQL), END); }
-  }
-  return MACRO_NONE;
 };
 
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
@@ -370,19 +387,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   }
 #endif
   switch (keycode) {
-    // dynamically generate these.
+    /* dynamically generate these. */
-    case EPRM:
-      if (record->event.pressed) {
-        eeconfig_init();
-      }
-      return false;
-      break;
-    case VRSN:
-      if (record->event.pressed) {
-        SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
-      }
-      return false;
-      break;
     case RGB_SLD:
       if (record->event.pressed) {
 #ifdef RGBLIGHT_ENABLE
@@ -391,16 +396,115 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
       }
       return false;
       break;
+    case M_BRACKET_IN_CBR:  /* {} */
+      if (record->event.pressed) {
+        SEND_STRING("{}" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_IN_PRN:  /* () */
+      if (record->event.pressed) {
+        SEND_STRING("()" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_IN_BRC:  /* [] */
+      if (record->event.pressed) {
+        SEND_STRING("[]" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_IN_ANG:  /* <> */
+      if (record->event.pressed) {
+        SEND_STRING("<>" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_OUT_CBR:  /* }{ */
+      if (record->event.pressed) {
+        SEND_STRING("}{" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_OUT_PRN:  /* )( */
+      if (record->event.pressed) {
+        SEND_STRING(")(" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_OUT_BRC:  /* ][ */
+      if (record->event.pressed) {
+        SEND_STRING("][" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_BRACKET_OUT_ANG:  /* >< */
+      if (record->event.pressed) {
+        SEND_STRING("><" SS_TAP(X_LEFT));
+        return false;
+      }
+      break;
+    case M_ARROW_LMINUS:  /* <- */
+      if (record->event.pressed) {
+        SEND_STRING("<-");
+        return false;
+      }
+      break;
+    case M_ARROW_RMINUS:  /* -> */
+      if (record->event.pressed) {
+        SEND_STRING("->");
+        return false;
+      }
+      break;
+    case M_ARROW_LEQL:  /* <= */
+      if (record->event.pressed) {
+        SEND_STRING("<=");
+        return false;
+      }
+      break;
+    case M_ARROW_REQL:  /* => */
+      if (record->event.pressed) {
+        SEND_STRING("=>");
+        return false;
+      }
+      break;
+    case KC_LSHIFT:  /* '' */
+      if (record->event.pressed && (keyboard_report->mods & (MOD_BIT(KC_RSFT)))) {
+        clear_mods();
+        SEND_STRING("''" SS_TAP(X_LEFT) SS_DOWN(X_RSHIFT) SS_DOWN(X_LSHIFT));
+        return false;
+      }
+      break;
+    case KC_RSHIFT:  /* "" */
+      if (record->event.pressed && (keyboard_report->mods & (MOD_BIT(KC_LSFT)))) {
+        clear_mods();
+        SEND_STRING("\x22\x22" SS_TAP(X_LEFT) SS_DOWN(X_LSHIFT) SS_DOWN(X_RSHIFT));
+        return false;
+      }
+      break;
+
+    case M_WORD_A...M_WORD_Z:
+    {
+      const char *word = cfq_word_lut[keycode - M_WORD_A];
+      if (record->event.pressed) {
+        if (*word) {
+          send_string(word);
+        }
+        return false;
+      }
+      break;
+    }
   }
+
   return true;
 }
 
-// Runs just one time when the keyboard initializes.
+/* Runs just one time when the keyboard initializes. */
 void matrix_init_user(void) {
 
 };
 
-// Runs constantly in the background, in a loop.
+/* Runs constantly in the background, in a loop. */
 void matrix_scan_user(void) {
 
   uint8_t layer = biton32(layer_state);
@@ -416,13 +520,11 @@ void matrix_scan_user(void) {
     case 2:
       ergodox_right_led_2_on();
       break;
-#ifdef CFQ_USE_EXPEREMENTAL_LAYER
     case 3:
       ergodox_right_led_3_on();
       break;
-#endif
     default:
-      // none
+      /* none */
       break;
   }
 

layouts/community/ergodox/qwerty_code_friendly/readme.md

@@ -3,7 +3,8 @@
 - This layout aims to balance muscle memory from a typical QWERTY layout
   with having keys used for software development easily accessible.
 
-- Arrow keys follow VIM convention (the media layer even uses arrow keys for HJKL).
+- Arrow keys follow VIM convention
+  (the media layer even uses arrow keys for HJKL).
 
 - On the top row only symbols are used (not numbers),
   it's expected the symbol layer's number-pad layout will be used for numbers.
@@ -17,65 +18,75 @@
   at the same key locations to type matching pairs.
 
 - The extra space-bar on the lower-left looks like it's in an obscure location,
-  however using the larger thumb cluster ended up being more of a reach while typing.
+  however using the larger thumb cluster
+  ended up being more of a reach while typing.
 
-- L3 is currently only used if `CFQ_USE_EXPEREMENTAL_LAYER` is defined,
+- There is a handy shortcut for writing quotes that inserts the cursor
-  this is a layer to place extra functionality and test new keys.
+  between the quotation marks.
+
+  Holding LShift, then RShift types: "" (then presses left).
+
+  Holding RShift, then LShift types: '' (then presses left).
 
 ## Configuration
 
 Some optional behavior is configurable without editing the code
 using `CFQ_` prefixed defines which can be set by passing `EXTRAFLAGS` to make.
 
-- `CFQ_USER_KEY1` (1..7) are used for custom-keys
+- `CFQ_USER_KEY0`
-- `CFQ_USE_MOMENTARY_LAYER_KEYS` is used to prevent layer keys from toggling when tapped.
+  (0..7) are used for custom-keys
-- `CFQ_USE_SWAP_RIGHT_SPACE_ENTER` swap Enter and Space on the right hand thumb cluster.
+- `CFQ_USE_MOMENTARY_LAYER_KEYS`
-  While asymmetric, it makes Enter more easily accessible.
+  is used to prevent layer keys from toggling when tapped.
-- `CFQ_USE_EXPEREMENTAL_LAYER` defines an extra layer for misc extra keys/macros.
+- `CFQ_WORD_[A-Z]`
-  When set, Caps-Lock is replace by Layer3.
+  defines can bind a key to an entire user defined word.
-  Currently it's mostly empty.
 
 
 
 ## Keymap 0: Basic layer
 
 ```
-Keymap 0: Basic layer
 ,--------------------------------------------------.           ,--------------------------------------------------.
 | Grave  |   !  |   @  |   #  |   $  |   %  |   {  |           |  }   |   ^  |   &  |   *  |   -  |   =  | BSpace |
-|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
 | Tab    |   Q  |   W  |   E  |   R  |   T  |   (  |           |  )   |   Y  |   U  |   I  |   O  |   P  |   \    |
 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 | Esc    |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |   ;  |   '    |
 |--------+------+------+------+------+------|   [  |           |  ]   |------+------+------+------+------+--------|
 | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |   ,  |   .  |   /  | RShift |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Del  |
+  | LCtl |Super | Alt  | ~L1  |Space |                                       | Left | Down | Up   |Right | Ins  |
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,-------------.
-                                       | Ins  |CapsLk|       | Home | End  |
+                                       |   <  |  >   |       | Home | End  |
-                                ,------|------|------|       |------+------+------.
+                                ,------+------+------|       |------+------+------.
-                                |      |      | ~L2  |       | PgUp |      |      |
+                                |      |      |CapsLk|       | PgUp |      |      |
-                                |Space |Enter |------|       |------|Enter |Space |
+                                |BSpace| Del  |------|       |------| ~L2  |Space |
-                                |      |      | ~L1  |       | PgDn |      |      |
+                                |      |      | ~L3  |       | PgDn |      |      |
                                 `--------------------'       `--------------------'
 
-Optional overrides: see CFQ_USER_KEY# defines
+Optional overrides: see CFQ_USER_KEY# defines.
 
-  -------+------+------+------+------+
+,--------------------------------------------------.           ,--------------------------------------------------.
-  |      |      |      | USR1 |      |
+|        |      |      |      |      |      |      |           |      |      |      |      |      |      | USR0   |
-  `----------------------------------'
+|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-
+|        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
-                                       ,-------------.
+|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-                                       | USR2 | USR3 |
+|        |      |      |      |      |      |------|           |------|      |      |      |      |      |        |
-                                ,------|------|------|
+|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-                                |      |      | USR6 |
+|        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
-                                | USR4 | USR5 |------|
+`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-                                |      |      | USR7 |
+  |      |      |      | USR1 |      |                                       |      |      |      |      |      |
-                                `--------------------'
+  `----------------------------------'                                       `----------------------------------'
+                                       ,-------------.       ,-------------.
+                                       | USR2 | USR3 |       |      |      |
+                                ,------+------+------|       |------+------+------.
+                                |      |      | USR6 |       |      |      |      |
+                                | USR4 | USR5 |------|       |------|      |      |
+                                |      |      | USR7 |       |      |      |      |
+                                `--------------------'       `--------------------'
 ```
 
-## Keymap 1: Symbol layer
+## Keymap 1: KeyPad, Macro Record
 
 Notes:
 
@@ -84,31 +95,31 @@ Notes:
 
 ```
 ,--------------------------------------------------.           ,--------------------------------------------------.
-|        |  F1  |  F2  |  F3  |  F4  |  F5  |  {}  |           |  }{  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
+|        |      |      |      |      |      |  {}  |           |  }{  |      |NumLck|   /  |   *  |   -  |        |
-|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
-|        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   \  |   F11  |
+|        |      |      |      |      |  =>  |  ()  |           |  )(  |  <=  |   7  |   8  |   9  |   +  |        |
 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
-|        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   *  |   F12  |
+|        |      |      |      |      |  ->  |------|           |------|  <-  |   4  |   5  |   6  |   +  |        |
 |--------+------+------+------+------+------|  []  |           |  ][  |------+------+------+------+------+--------|
-|        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  |   -  |        |
+|        |      |      |      |      |  <>  |      |           |      |  ><  |   1  |   2  |   3  | Enter|        |
 `--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
-  |      |      |      |      |      |                                       |   0  |      |   .  |   +  |      |
+  |      |      |      |      |      |                                       |   0  |      |   .  | Enter|      |
   `----------------------------------'                                       `----------------------------------'
-                                       ,-------------.       ,---------------.
+                                       ,-------------.       ,--------------.
-                                       |Start1|Start2|       |      |        |
+                                       |Start1|Start2|       |      |       |
-                                ,------|------|------|       |------+--------+------.
+                                ,------+------+------|       |------+-------+------.
-                                |      |      | Stop |       |      |        |      |
+                                |      |      | Stop |       |      |       |      |
-                                |Play1 |Play2 |------|       |------|        |      |
+                                |Play1 |Play2 |------|       |------|       |      |
-                                |      |      |      |       |      |        |      |
+                                |      |      |      |       |      |       |      |
-                                `--------------------'       `----------------------'
+                                `--------------------'       `---------------------'
 ```
 
-## Keymap 2: Media and mouse keys
+## Keymap 2: Keymap 2: Media and mouse keys
 
 ```
 ,--------------------------------------------------.           ,--------------------------------------------------.
 |        |      |      |      |      |      |      |           |      |      |      |      |      |      |        |
-|--------+------+------+------+------+-------------|           |------+------+------+------+------+------+--------|
+|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
 |        |      |      | MsUp |      |      |MWhlUp|           |      |      |      |      |      |      |        |
 |--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
 |        |      |MsLeft|MsDown|MsRght|      |------|           |------| Left | Down | Up   |Right |      |        |
@@ -119,15 +130,53 @@ Notes:
   `----------------------------------'                                       `----------------------------------'
                                        ,-------------.       ,-------------.
                                        | MRwd | MFwd |       | MPrv | MNxt |
-                                ,------|------|------|       |------+------+------.
+                                ,------+------+------|       |------+------+------.
                                 |      |      |      |       |VolUp |      |      |
-                                |      |      |------|       |------| Mute | Play |
+                                | Mute |      |------|       |------|      | Play |
                                 |      |      |      |       |VolDn |      |      |
                                 `--------------------'       `--------------------'
 ```
 
+## Keymap 3: K-Keys & User defined words
+
+This is for assigning whole words to single keys.
+You can define the arguments (which must be quoted) using: `CFQ_WORD_[A-Z]`
+eg: `-DCFQ_WORD_E=\"[email protected]\"`
+
+```
+,--------------------------------------------------.           ,--------------------------------------------------.
+|        |  F1  |  F2  |  F3  |  F4  |  F5  |  F11 |           | F12  |  F6  |  F7  |  F8  |  F9  |  F10 |        |
+|--------+------+------+------+------+------+------|           |------+------+------+------+------+------+--------|
+|        |   Q  |   W  |   E  |   R  |   T  |      |           |      |   Y  |   U  |   I  |   O  |   P  |        |
+|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+|        |   A  |   S  |   D  |   F  |   G  |------|           |------|   H  |   J  |   K  |   L  |      |        |
+|--------+------+------+------+------+------|      |           |      |------+------+------+------+------+--------|
+|        |   Z  |   X  |   C  |   V  |   B  |      |           |      |   N  |   M  |      |      |      |        |
+`--------+------+------+------+------+-------------'           `-------------+------+------+------+------+--------'
+  |      |      |      |      |      |                                       |      |      |      |      |      |
+  `----------------------------------'                                       `----------------------------------'
+                                       ,-------------.       ,-------------.
+                                       |      |      |       |      |      |
+                                ,------+------+------|       |------+------+------.
+                                |      |      |      |       |      |      |      |
+                                |      |      |------|       |------|      |      |
+                                |      |      |      |       |      |      |      |
+                                `--------------------'       `--------------------'
+```
+
 ## Changelog
 
+- 2018/03/06
+  Add layer for user defined words (replaces `CFQ_USE_EXPEREMENTAL_LAYER`).
+
+  Minor changes to thumb cluster.
+
+  Move backspace to left thumb, optionally remap the top right backspace.
+
+  Make keypad layout match a typical numpad.
+
+  Move F-Keys to layer 3.
+
 - 2017/11/09
   Use Caps-Lock when `CFQ_USE_EXPEREMENTAL_LAYER` isn't defined.
 

layouts/community/ergodox/supercoder/readme.md

@@ -15,8 +15,7 @@ Behold the Ultimate SuperCoder 2000 layout!
 
 ### To use it...
 
-To use this piece of top quality engineering, you can either
+To use this piece of top quality engineering, you must compile it on
-[download the hex file][hex] we have prepared for you, or you can compile it on
 your own:
 
  [hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex