Fix omnikeyish

.clang_complete

@@ -0,0 +1,24 @@
+
+-I.
+-I./drivers
+-I./drivers/avr
+-I./keyboards/ergodox_ez
+-I./keyboards/ergodox_ez/keymaps/vim
+-I./lib
+-I./lib/lufa
+-I./quantum
+-I./quantum/api
+-I./quantum/audio
+-I./quantum/keymap_extras
+-I./quantum/process_keycode
+-I./quantum/serial_link
+-I./quantum/template
+-I./quantum/tools
+-I./quantum/visualizer
+-I./tmk_core
+-I./tmk_core/common
+-I./tmk_core/common/debug.h
+-I./tmk_core/protocol
+-I./tmk_core/protocol/lufa
+-I./util
+-DQMK_KEYBOARD=\"$(KEYBOARD)\" -DQMK_KEYMAP=\"$(KEYMAP)\"

.github/PULL_REQUEST_TEMPLATE.md

@@ -26,8 +26,7 @@
 
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] My code follows the code style of this project: [**C**](https://docs.qmk.fm/#/coding_conventions_c), [**Python**](https://docs.qmk.fm/#/coding_conventions_python)
-- [ ] I have read the [**PR Checklist** document](https://docs.qmk.fm/#/pr_checklist) and have made the appropriate changes.
+- [ ] My code follows the code style of this project.
 - [ ] My change requires a change to the documentation.
 - [ ] I have updated the documentation accordingly.
 - [ ] I have read the [**CONTRIBUTING** document](https://docs.qmk.fm/#/contributing).

.github/workflows/cli.yml

@@ -19,7 +19,7 @@ jobs:
     container: qmkfm/base_container
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v1
       with:
         submodules: recursive
     - name: Install dependencies

.github/workflows/info.yml

@@ -1,54 +0,0 @@
-name: PR Lint keyboards
-
-on:
-  pull_request:
-    paths:
-    - 'keyboards/**'
-
-jobs:
-  info:
-    runs-on: ubuntu-latest
-
-    container: qmkfm/base_container
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-
-    - uses: trilom/file-changes-action@v1.2.4
-      id: file_changes
-      with:
-        output: '\n'
-
-    - name: Print info
-      run: |
-        git rev-parse --short HEAD
-        echo ${{ github.event.pull_request.base.sha }}
-        echo '${{ steps.file_changes.outputs.files}}'
-
-    - name: Run qmk info
-      shell: 'bash {0}'
-      run: |
-        QMK_CHANGES=$(echo -e '${{ steps.file_changes.outputs.files}}')
-        QMK_KEYBOARDS=$(qmk list-keyboards)
-
-        exit_code=0
-        for KB in $QMK_KEYBOARDS; do
-          KEYBOARD_CHANGES=$(echo "$QMK_CHANGES" | grep -E '^(keyboards/'${KB}'/)')
-          if [[ -z "$KEYBOARD_CHANGES" ]]; then
-            # skip as no changes for this keyboard
-            continue
-          fi
-
-          KEYMAP_ONLY=$(echo "$KEYBOARD_CHANGES" | grep -cv /keymaps/)
-          if [[ $KEYMAP_ONLY -gt 0 ]]; then
-            echo "linting ${KB}"
-
-            # TODO: info info always returns 0 - right now the only way to know failure is to inspect log lines
-            qmk info -l -kb ${KB} 2>&1 | tee /tmp/$$
-            !(grep -cq ☒ /tmp/$$)
-            : $((exit_code = $exit_code + $?))
-          fi
-        done
-        exit $exit_code

.gitignore

@@ -24,7 +24,6 @@ quantum/version.h
 .idea/
 CMakeLists.txt
 cmake-build-debug
-.clang_complete
 doxygen/
 .DS_Store
 /util/wsl_downloaded
@@ -48,6 +47,7 @@ doxygen/
 *.iml
 .browse.VC.db*
 *.stackdump
+util/Win_Check_Output.txt
 # Let these ones be user specific, since we have so many different configurations
 .vscode/c_cpp_properties.json
 .vscode/launch.json
@@ -73,6 +73,3 @@ __pycache__
 
 # prerequisites for updating ChibiOS
 /util/fmpp*
-
-# Allow to exist but don't include it in the repo
-user_song_list.h

.gitmodules

@@ -12,13 +12,7 @@
 	branch = master
 [submodule "lib/googletest"]
 	path = lib/googletest
-	url = https://github.com/qmk/googletest
+	url = https://github.com/google/googletest
 [submodule "lib/lufa"]
 	path = lib/lufa
 	url = https://github.com/qmk/lufa
-[submodule "lib/vusb"]
-	path = lib/vusb
-	url = https://github.com/qmk/v-usb
-[submodule "lib/printf"]
-	path = lib/printf
-	url = https://github.com/qmk/printf

.travis.yml

@@ -27,7 +27,6 @@ addons:
 install:
   - npm install -g moxygen
 script:
-  - git fetch --depth=50 origin $TRAVIS_BRANCH:$TRAVIS_BRANCH
   - git rev-parse --short HEAD
   - git diff --name-only HEAD $TRAVIS_BRANCH
   - bash util/travis_test.sh

.vscode/settings.json

@@ -9,18 +9,12 @@
         "**/*.bin": true
     },
     "files.associations": {
-        "*.h": "c",
-        "*.c": "c",
-        "*.inc": "c",
-        "*.cpp": "cpp",
-        "*.hpp": "cpp",
-        "xstddef": "c",
-        "type_traits": "c",
-        "utility": "c",
-        "ranges": "c"
-    },
-    "[markdown]": {
-        "editor.trimAutoWhitespace": false,
-        "files.trimTrailingWhitespace": false
+      "*.h": "c",
+      "*.c": "c",
+      "*.cpp": "cpp",
+      "*.hpp": "cpp",
+      "xstddef": "c",
+      "type_traits": "c",
+      "utility": "c"
     }
 }

Makefile

@@ -29,9 +29,6 @@ $(info QMK Firmware $(QMK_VERSION))
 endif
 endif
 
-# avoid 'Entering|Leaving directory' messages
-MAKEFLAGS += --no-print-directory
-
 ON_ERROR := error_occurred=1
 
 BREAK_ON_ERRORS = no
@@ -294,8 +291,8 @@ define PARSE_RULE
         $$(info |  QMK's make format recently changed to use folder locations and colons:)
         $$(info |     make project_folder:keymap[:target])
         $$(info |  Examples:)
-        $$(info |     make dz60:default)
-        $$(info |     make planck/rev6:default:flash)
+        $$(info |     make planck/rev4:default:dfu)
+        $$(info |     make planck:default)
         $$(info |)
     endif
 endef
@@ -562,16 +559,14 @@ endef
 %:
 	# Check if we have the CMP tool installed
 	cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
-	# Ensure that bin/qmk works. This will be a failing check after the next develop merge on 2020 Aug 29.
-	if ! bin/qmk hello 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; fi
+	# Ensure that python3 is installed. This check can be removed after python is used in more places.
+	if ! python3 --version 1> /dev/null 2>&1; then printf "$(MSG_PYTHON_MISSING)"; fi
 	# Check if the submodules are dirty, and display a warning if they are
 ifndef SKIP_GIT
 	if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --depth 50 --init lib/chibios; fi
 	if [ ! -e lib/chibios-contrib ]; then git submodule sync lib/chibios-contrib && git submodule update --depth 50 --init lib/chibios-contrib; fi
 	if [ ! -e lib/ugfx ]; then git submodule sync lib/ugfx && git submodule update --depth 50 --init lib/ugfx; fi
 	if [ ! -e lib/lufa ]; then git submodule sync lib/lufa && git submodule update --depth 50 --init lib/lufa; fi
-	if [ ! -e lib/vusb ]; then git submodule sync lib/vusb && git submodule update --depth 50 --init lib/vusb; fi
-	if [ ! -e lib/printf ]; then git submodule sync lib/printf && git submodule update --depth 50 --init lib/printf; fi
 	git submodule status --recursive 2>/dev/null | \
 	while IFS= read -r x; do \
 		case "$$x" in \

Vagrantfile

@@ -89,7 +89,7 @@ Vagrant.configure(2) do |config|
 
   Examples:
      make planck/rev4:default:dfu
-     make planck/rev4:default
+     make planck:default
 
   EOT
 end

bin/qmk

@@ -2,61 +2,52 @@
 """CLI wrapper for running QMK commands.
 """
 import os
+import subprocess
 import sys
 from importlib.util import find_spec
-from pathlib import Path
+from time import strftime
 
 # Add the QMK python libs to our path
-script_dir = Path(os.path.realpath(__file__)).parent
-qmk_dir = script_dir.parent
-python_lib_dir = Path(qmk_dir / 'lib' / 'python').resolve()
-sys.path.append(str(python_lib_dir))
+script_dir = os.path.dirname(os.path.realpath(__file__))
+qmk_dir = os.path.abspath(os.path.join(script_dir, '..'))
+python_lib_dir = os.path.abspath(os.path.join(qmk_dir, 'lib', 'python'))
+sys.path.append(python_lib_dir)
 
-
-def _check_modules(requirements):
-    """ Check if the modules in the given requirements.txt are available.
-    """
-    with Path(qmk_dir / requirements).open() as fd:
-        for line in fd.readlines():
-            line = line.strip().replace('<', '=').replace('>', '=')
-
-            if len(line) == 0 or line[0] == '#' or line.startswith('-r'):
-                continue
-
-            if '#' in line:
-                line = line.split('#')[0]
-
-            module = dict()
-            module['name'] = module['import'] = line.split('=')[0] if '=' in line else line
-
-            # Not every module is importable by its own name.
-            if module['name'] == "pep8-naming":
-                module['import'] = "pep8ext_naming"
-
-            if not find_spec(module['import']):
-                print('Could not find module %s!' % module['name'])
-                print('Please run `python3 -m pip install -r %s` to install required python dependencies.' % (qmk_dir / requirements,))
-                if developer:
-                    print('You can also turn off developer mode: qmk config user.developer=None')
-                print()
-                exit(255)
-
-
-developer = False
 # Make sure our modules have been setup
-_check_modules('requirements.txt')
+with open(os.path.join(qmk_dir, 'requirements.txt'), 'r') as fd:
+    for line in fd.readlines():
+        line = line.strip().replace('<', '=').replace('>', '=')
+
+        if line[0] == '#':
+            continue
+
+        if '#' in line:
+            line = line.split('#')[0]
+
+        module = line.split('=')[0] if '=' in line else line
+
+        if module in ['pep8-naming']:
+            # Not every module is importable by its own name.
+            continue
+
+        if not find_spec(module):
+            print('Could not find module %s!' % module)
+            print('Please run `pip3 install -r requirements.txt` to install the python dependencies.')
+            exit(255)
+
+# Figure out our version
+# TODO(skullydazed/anyone): Find a method that doesn't involve git. This is slow in docker and on windows.
+command = ['git', 'describe', '--abbrev=6', '--dirty', '--always', '--tags']
+result = subprocess.run(command, universal_newlines=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+
+if result.returncode == 0:
+    os.environ['QMK_VERSION'] = result.stdout.strip()
+else:
+    os.environ['QMK_VERSION'] = 'nogit-' + strftime('%Y-%m-%d-%H:%M:%S') + '-dirty'
 
 # Setup the CLI
 import milc  # noqa
 
-# For developers additional modules are needed
-if milc.cli.config.user.developer:
-    # Do not run the check for 'config',
-    # so users can turn off developer mode
-    if len(sys.argv) == 1 or (len(sys.argv) > 1 and 'config' != sys.argv[1]):
-        developer = True
-        _check_modules('requirements-dev.txt')
-
 milc.EMOJI_LOGLEVELS['INFO'] = '{fg_blue}Ψ{style_reset_all}'
 
 

bootloader.mk

@@ -27,7 +27,6 @@
 # qmk-dfu        QMK DFU (LUFA + blinkenlight)
 # bootloadHID    HIDBootFlash compatible (ATmega32A)
 # USBasp         USBaspLoader (ATmega328P)
-# kiibohd        Input:Club Kiibohd bootloader (only used on their boards)
 #
 # BOOTLOADER_SIZE can still be defined manually, but it's recommended
 # you add any possible configuration to this list
@@ -90,19 +89,7 @@ ifeq ($(strip $(BOOTLOADER)), lufa-ms)
     BOOTLOADER_SIZE = 6144
     FIRMWARE_FORMAT = bin
 endif
+
 ifdef BOOTLOADER_SIZE
     OPT_DEFS += -DBOOTLOADER_SIZE=$(strip $(BOOTLOADER_SIZE))
 endif
-
-ifeq ($(strip $(BOOTLOADER)), kiibohd)
-    OPT_DEFS += -DBOOTLOADER_KIIBOHD
-    ifeq ($(strip $(MCU_ORIG)), MK20DX128)
-        MCU_LDSCRIPT = MK20DX128BLDR4
-    endif
-    ifeq ($(strip $(MCU_ORIG)), MK20DX256)
-        MCU_LDSCRIPT = MK20DX256BLDR8
-    endif
-
-    DFU_ARGS = -d 1C11:B007
-    DFU_SUFFIX_ARGS = -v 1C11 -p B007
-endif

build_json.mk

@@ -21,11 +21,6 @@ else ifneq ("$(wildcard $(MAIN_KEYMAP_PATH_1)/keymap.json)","")
     KEYMAP_PATH := $(MAIN_KEYMAP_PATH_1)
 endif
 
-# Load the keymap-level rules.mk if exists
-ifneq ("$(wildcard $(KEYMAP_PATH))", "")
-    -include $(KEYMAP_PATH)/rules.mk
-endif
-
 # Generate the keymap.c
 $(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
-	bin/qmk json2c --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)
+	bin/qmk json-keymap --quiet --output $(KEYMAP_C) $(KEYMAP_JSON)

build_keyboard.mk

@@ -16,6 +16,7 @@ include common.mk
 KEYBOARD_FILESAFE := $(subst /,_,$(KEYBOARD))
 TARGET ?= $(KEYBOARD_FILESAFE)_$(KEYMAP)
 KEYBOARD_OUTPUT := $(BUILD_DIR)/obj_$(KEYBOARD_FILESAFE)
+STM32_PATH := quantum/stm32
 
 # Force expansion
 TARGET := $(TARGET)
@@ -137,7 +138,7 @@ endif
 
 ifeq ($(strip $(CONVERT_TO_PROTON_C)), yes)
     TARGET := $(TARGET)_proton_c
-    include platforms/chibios/GENERIC_STM32_F303XC/configs/proton_c.mk
+    include $(STM32_PATH)/proton_c.mk
     OPT_DEFS += -DCONVERT_TO_PROTON_C
 endif
 
@@ -147,6 +148,12 @@ endif
 
 include quantum/mcu_selection.mk
 
+ifdef MCU_FAMILY
+    OPT_DEFS += -DQMK_STM32
+    KEYBOARD_PATHS += $(STM32_PATH)
+endif
+
+
 # Find all the C source files to be compiled in subfolders.
 KEYBOARD_SRC :=
 
@@ -224,19 +231,44 @@ endif
 # We can assume a ChibiOS target When MCU_FAMILY is defined since it's
 # not used for LUFA
 ifdef MCU_FAMILY
-    PLATFORM=CHIBIOS
-    PLATFORM_KEY=chibios
     FIRMWARE_FORMAT?=bin
+    PLATFORM=CHIBIOS
 else ifdef ARM_ATSAM
     PLATFORM=ARM_ATSAM
-    PLATFORM_KEY=arm_atsam
     FIRMWARE_FORMAT=bin
 else
     PLATFORM=AVR
-    PLATFORM_KEY=avr
     FIRMWARE_FORMAT?=hex
 endif
 
+ifeq ($(PLATFORM),CHIBIOS)
+    include $(TMK_PATH)/chibios.mk
+    OPT_OS = chibios
+    ifneq ("$(wildcard $(KEYBOARD_PATH_5)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_5)/bootloader_defs.h
+     else ifneq ("$(wildcard $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_5)/boards/$(BOARD)/bootloader_defs.h
+    else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_4)/bootloader_defs.h
+     else ifneq ("$(wildcard $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_4)/boards/$(BOARD)/bootloader_defs.h
+    else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_3)/bootloader_defs.h
+     else ifneq ("$(wildcard $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_3)/boards/$(BOARD)/bootloader_defs.h
+    else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_2)/bootloader_defs.h
+     else ifneq ("$(wildcard $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_2)/boards/$(BOARD)/bootloader_defs.h
+    else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_1)/bootloader_defs.h
+     else ifneq ("$(wildcard $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(KEYBOARD_PATH_1)/boards/$(BOARD)/bootloader_defs.h
+    else ifneq ("$(wildcard $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h)","")
+        OPT_DEFS += -include $(TOP_DIR)/drivers/boards/$(BOARD)/bootloader_defs.h
+    endif
+endif
+
 # Find all of the config.h files and add them to our CONFIG_H define.
 CONFIG_H :=
 ifneq ("$(wildcard $(KEYBOARD_PATH_5)/config.h)","")
@@ -272,6 +304,11 @@ ifneq ("$(wildcard $(KEYBOARD_PATH_5)/post_config.h)","")
     POST_CONFIG_H += $(KEYBOARD_PATH_5)/post_config.h
 endif
 
+# Save the defines and includes here, so we don't include any keymap specific ones
+PROJECT_DEFS := $(OPT_DEFS)
+PROJECT_INC := $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
+PROJECT_CONFIG := $(CONFIG_H)
+
 # Userspace setup and definitions
 ifeq ("$(USER_NAME)","")
     USER_NAME := $(KEYMAP)
@@ -317,17 +354,23 @@ SRC += $(TMK_COMMON_SRC)
 OPT_DEFS += $(TMK_COMMON_DEFS)
 EXTRALDFLAGS += $(TMK_COMMON_LDFLAGS)
 
-include $(TMK_PATH)/$(PLATFORM_KEY).mk
-ifneq ($(strip $(PROTOCOL)),)
-    include $(TMK_PATH)/protocol/$(strip $(shell echo $(PROTOCOL) | tr '[:upper:]' '[:lower:]')).mk
+ifeq ($(PLATFORM),AVR)
+ifeq ($(strip $(PROTOCOL)), VUSB)
+    include $(TMK_PATH)/protocol/vusb.mk
 else
-    include $(TMK_PATH)/protocol/$(PLATFORM_KEY).mk
+    include $(TMK_PATH)/protocol/lufa.mk
+endif
+    include $(TMK_PATH)/avr.mk
 endif
 
-# TODO: remove this bodge?
-PROJECT_DEFS := $(OPT_DEFS)
-PROJECT_INC := $(VPATH) $(EXTRAINCDIRS) $(KEYBOARD_PATHS)
-PROJECT_CONFIG := $(CONFIG_H)
+ifeq ($(PLATFORM),ARM_ATSAM)
+    include $(TMK_PATH)/arm_atsam.mk
+    include $(TMK_PATH)/protocol/arm_atsam.mk
+endif
+
+ifeq ($(PLATFORM),CHIBIOS)
+    include $(TMK_PATH)/protocol/chibios.mk
+endif
 
 ifeq ($(strip $(VISUALIZER_ENABLE)), yes)
     VISUALIZER_DIR = $(QUANTUM_DIR)/visualizer

build_layout.mk

@@ -3,14 +3,8 @@ LAYOUTS_REPOS := $(patsubst %/,%,$(sort $(dir $(wildcard $(LAYOUTS_PATH)/*/))))
 
 define SEARCH_LAYOUTS_REPO
     LAYOUT_KEYMAP_PATH := $$(LAYOUTS_REPO)/$$(LAYOUT)/$$(KEYMAP)
-    LAYOUT_KEYMAP_JSON := $$(LAYOUT_KEYMAP_PATH)/keymap.json
     LAYOUT_KEYMAP_C := $$(LAYOUT_KEYMAP_PATH)/keymap.c
-    ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_JSON))","")
-        -include $$(LAYOUT_KEYMAP_PATH)/rules.mk
-        KEYMAP_C := $(KEYBOARD_OUTPUT)/src/keymap.c
-        KEYMAP_JSON := $$(LAYOUT_KEYMAP_JSON)
-        KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
-    else ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_C))","")
+    ifneq ("$$(wildcard $$(LAYOUT_KEYMAP_C))","")
         -include $$(LAYOUT_KEYMAP_PATH)/rules.mk
         KEYMAP_C := $$(LAYOUT_KEYMAP_C)
         KEYMAP_PATH := $$(LAYOUT_KEYMAP_PATH)
@@ -30,7 +24,4 @@ ifneq ($(FORCE_LAYOUT),)
     endif
 endif
 
-$(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))
-
-# Use rule from build_json.mk, but update prerequisite in case KEYMAP_JSON was updated
-$(KEYBOARD_OUTPUT)/src/keymap.c: $(KEYMAP_JSON)
+$(foreach LAYOUT,$(LAYOUTS),$(eval $(call SEARCH_LAYOUTS)))

build_test.mk

@@ -41,7 +41,6 @@ all: elf
 
 VPATH += $(COMMON_VPATH)
 PLATFORM:=TEST
-PLATFORM_KEY:=test
 
 ifneq ($(filter $(FULL_TESTS),$(TEST)),)
 include tests/$(TEST)/rules.mk

docs/ChangeLog/20200530.md

@@ -1,239 +0,0 @@
-# QMK Breaking Change - 2020 May 30 Changelog
-
-Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
-
-The list of changes follows.
-
-
-## Core Changes
-
-### Converting V-USB usbdrv to a submodule
-
-[#8321](https://github.com/qmk/qmk_firmware/pull/8321) and [qmk_compiler#62](https://github.com/qmk/qmk_compiler/pull/62).
-
-These PRs move the V-USB driver code out of the qmk_firmware repository and into a submodule pointed at https://github.com/obdev/v-usb. This will make it easier to update the codebase if needed, while applying any potential QMK-specific modifications by forking it to the QMK GitHub organization.
-
-### Unify Tap Hold functions and documentation
-
-[#8348](https://github.com/qmk/qmk_firmware/pull/8348)
-
-Updates all of the per key tap-hold functions to pass the `keyrecord_t` structure, and include documentation changes.
-
-Any remaining versions or code outside of the main repo will need to be converted: 
-| Old function                                         | New Function                                                              |
-|------------------------------------------------------|---------------------------------------------------------------------------|
-|`uint16_t get_tapping_term(uint16_t keycode)`         |`uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record)`         |
-|`bool get_ignore_mod_tap_interrupt(uint16_t keycode)` |`bool get_ignore_mod_tap_interrupt(uint16_t keycode, keyrecord_t *record)` |
-
-### Python Required In The Build Process
-
-[#9000](https://github.com/qmk/qmk_firmware/pull/9000)
-
-This is the last release of QMK that will work without having Python 3.6 (or later) installed. If your environment is not fully setup you will get a warning instructing you to set it up.
-
-After the next breaking change you will not be able to build if `bin/qmk hello` does not work.
-
-### Upgrade from tinyprintf to mpaland/printf
-
-[#8269](https://github.com/qmk/qmk_firmware/pull/8269)
-
-- Provides debug functionality on ChibiOS/ARM that is more compliant than previous integrations.
-- Less maintenence, fewer QMK customisations, and allows QMK to sidestep previous compile and runtime issues.
-- A `make git-submodule` may be required after pulling the latest QMK Firmware code to update to the new dependency.
-
-### Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup
-
-[#6480](https://github.com/qmk/qmk_firmware/pull/6480)
-
-- Changes `RGB_DISABLE_AFTER_TIMEOUT` to be based on milliseconds instead of ticks.
-- Includes a code cleanup, resulting in a savings of 100 bytes, depending on features used.
-- Fixed issues with timeouts / suspending at the wrong time not turning off all LEDs in some cases.
-
-The `RGB_DISABLE_AFTER_TIMEOUT` definition is now deprecated, and has been superseded by `RGB_DISABLE_TIMEOUT`. To use the new definition, rename `RGB_DISABLE_AFTER_TIMEOUT` to `RGB_DISABLE_TIMEOUT` in your `config.h` file, and multiply the value set by 1200.
-
-Before: `#define RGB_DISABLE_AFTER_TIMEOUT 100`  
-After: `#define RGB_DISABLE_TIMEOUT 120000`
-
-### Switch to qmk forks for everything
-
-[#9019](https://github.com/qmk/qmk_firmware/pull/9019)
-
-Fork all QMK submodules to protect against upstream repositories disappearing.
-
-### code cleanup regarding deprecated macro PLAY_NOTE_ARRAY by replacing it with PLAY_SONG
-
-[#8484](https://github.com/qmk/qmk_firmware/pull/8484)
-
-Removes the deprecated `PLAY_NOTE_ARRAY` macro. References to it are replaced with `PLAY_SONG`, which references the same function.
-
-### fixing wrong configuration of AUDIO feature
-
-[#8903](https://github.com/qmk/qmk_firmware/pull/8903) and [#8974](https://github.com/qmk/qmk_firmware/pull/8974)
-
-`audio_avr.c` does not default to any pin; there has to be a #define XX_AUDIO in config.h at some level for Audio to actually work. Otherwise, the Audio code ends up cluttering the firmware, possibly breaking builds because the maximum allowed firmware size is exceeded.
-
-These changes fix this by disabling Audio on keyboards that have the feature misconfigured, and therefore non-functional.
-
-Also, add a compile-time error to alert the user to a missing pin-configuration (on AVR boards) when `AUDIO_ENABLE = yes` is set.
-
-
-## Keyboard Refactors
-
-### Migrating Lily58 to use split_common
-
-[#6260](https://github.com/qmk/qmk_firmware/pull/6260)
-
-Modifies the default firmware for Lily58 to use the `split_common` library, instead of including and depending on its own set of libraries for the following functionality:
-
-- SSD1306 display
-- i2c for OLED
-- Serial Communication
-
-This allows current lily58 firmware to advance with updates to the `split_common` library, which is shared with many other split keyboards.
-
-#### To migrate existing Lily58 firmware:
-
-[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-445ac369c8717dcd6fc6fc3630836fc1):
-- Remove `#define SSD1306OLED` from config.h
-
-
-[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7):
-- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE`
-- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190)
-- Alternatively, if you did not change the OLED code from that in `default`, you may find it easier to simply copy the [relevant section](https://github.com/qmk/qmk_firmware/blob/4ac310668501ae6786c711ecc8f01f62ddaa1c0b/keyboards/lily58/keymaps/default/keymap.c#L138-L172). Otherwise, the changes you need to make are as follows (sample change [here](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7R138-R173))
-- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L138-L141) the block
-```c
-#ifdef SSD1306OLED	
-  iota_gfx_init(!has_usb());   // turns on the display	
-#endif
-```
-- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides:
-```c
-oled_rotation_t oled_init_user(oled_rotation_t rotation) {
-  if (!is_keyboard_master())
-    return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
-  return rotation;
-}
-```
-- Remove the functions `matrix_scan_user`, `matrix_update` and `iota_gfx_task_user`
-- Find/Replace `matrix_render_user(struct CharacterMatrix *matrix)` with `iota_gfx_task_user(void)`
-- Find/Replace `is_master` with `is_keyboard_master()`
-- For each instance of `matrix_write_ln(matrix, display_fn())`, rewrite it as `oled_write_ln(read_layer_state(), false);`
-- For each instance of `matrix_write(matrix, read_logo());`, replace with `oled_write(read_logo(), false);`
-
-### Refactor zinc to use split_common
-
-[#7114](https://github.com/qmk/qmk_firmware/pull/7114) and [#9171](https://github.com/qmk/qmk_firmware/pull/9171)
-
-* Refactor to use split_common and remove split codes under the zinc/revx/
-* Add - backlight RGB LED and/or underglow RGB LED option
-* Add - continuous RGB animations feature (between L and R halves) 
-* Fix - keymap files to adapt to changes
-    * all authors of keymaps confirmed this PR
-* Update - documents and rules.mk
-
-### Refactor of TKC1800 to use common OLED code
-
-[#8472](https://github.com/qmk/qmk_firmware/pull/8472)
-
-Modifies the default firmware for TKC1800 to use the in-built I2C and OLED drivers, instead of including and depending on its own set of libraries for the following functionality:
-
-- SSD1306 display
-- i2c for OLED
-
-This allows current TKC1800 firmware to advance with updates to those drivers, which are shared with other keyboards.
-
-#### To migrate existing TKC1800 firmware:
-
-[Changes to `config.h`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-d10b26e676b4a55cbb00d71955116526):
-- Remove `#define SSD1306OLED` from config.h
-
-[Changes to `tkc1800.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-3b35bd30abe89c8110717c6972cd2cc5):
-- Add the following to avoid debug errors on HID_listen if the screen is not present
-```c
-void keyboard_pre_init_kb(void) {
-  setPinInputHigh(D0);
-  setPinInputHigh(D1);
-
-  keyboard_pre_init_user();
-}
-```
-
-[Changes to `keymap.c`](https://github.com/qmk/qmk_firmware/pull/8472/files#diff-05a2a344ce27e4d045fe68520ccd4771):
-- Find/Replace each instance of `#ifdef SSD1306OLED` with `#ifdef OLED_DRIVER_ENABLE`
-- The following changes are for compatibility with the OLED driver. If you don't use the OLED driver you may safely delete [this section](https://github.com/qmk/qmk_firmware/blob/e6b9980bd45c186f7360df68c24b6e05a80c10dc/keyboards/lily58/keymaps/default/keymap.c#L144-L190)
-- [Remove](https://github.com/qmk/qmk_firmware/pull/6260/files#diff-20943ea59856e9bdf3d99ecb2eee40b7L91-L158) the block
-```c
-#ifdef SSD1306OLED	
-  iota_gfx_init(!has_usb());   // turns on the display	
-#endif
-```
-- Within the block bounded by `#ifdef OLED_DRIVER_ENABLE` and `#endif // OLED_DRIVER_ENABLE`, add the following block to ensure that your two OLEDs are rotated correctly across the left and right sides:
-```c
-oled_rotation_t oled_init_user(oled_rotation_t rotation) {
-  if (!is_keyboard_master())
-    return OLED_ROTATION_180;  // flips the display 180 degrees if offhand
-  return rotation;
-}
-```
-- Remove the function `iota_gfx_task_user`
-
-### Split HHKB to ANSI and JP layouts and Add VIA support for each
-
-[#8582](https://github.com/qmk/qmk_firmware/pull/8582)
-
-- Splits the HHKB codebase into two separate folders `keyboards/hhkb/ansi` and `keyboards/hhkb/jp`.
-- Adds VIA Configurator support for both versions.
-
-#### Migrating existing HHKB keymaps
-
-- Remove any checks for the `HHKB_JP` definition
-  - All checks for this definition have been removed, and each version uses the source that is appropriate to that version.
-- Move the directory for your keymap into the appropriate `keymaps` directory
-  - `keyboards/hhkb/ansi/keymaps/` for ANSI HHKBs
-  - `keyboards/hhkb/jp/keymaps/` for HHKB JPs
-- Compile with the new keyboard names
-  - This PR changes the compilation instructions for the HHKB Alternate Controller. To compile firmware for this controller moving forward, use:
-    - `make hhkb/ansi` for ANSI-layout HHKBs
-    - `make hhkb/jp` for HHKB JP keyboards
-
-
-## Keyboard Moves
-
-- [#8412](https://github.com/qmk/qmk_firmware/pull/8412 "Changing board names to prevent confusion") by blindassassin111
-- [#8499](https://github.com/qmk/qmk_firmware/pull/8499 "Move the Keyboardio Model01 to a keyboardio/ subdir") by algernon
-- [#8830](https://github.com/qmk/qmk_firmware/pull/8830 "Move spaceman keyboards") by Spaceman (formerly known as Rionlion100)
-- [#8537](https://github.com/qmk/qmk_firmware/pull/8537 "Organizing my keyboards (plaid, tartan, ergoinu)") by hsgw
-
-Keyboards by Keyboardio, Spaceman, and hsgw move to vendor folders, while PCBs designed by blindassassin111 are renamed.
-
-Old Name           | New Name
-:----------------- | :-----------------
-2_milk             | spaceman/2_milk
-at101_blackheart   | at101_bh
-ergoinu            | dm9records/ergoinu
-model01            | keyboardio/model01
-omnikey_blackheart | omnikey_bh
-pancake            | spaceman/pancake
-plaid              | dm9records/plaid
-tartan             | dm9records/tartan
-z150_blackheart    | z150_bh
-
-If you own one of these PCBs, please use the new names to compile your firmware moving forward.
-
-
-## Keycode Migration PRs
-
-[#8954](https://github.com/qmk/qmk_firmware/pull/8954 "Migrate `ACTION_LAYER_TOGGLE` to `TG()`"), [#8957](https://github.com/qmk/qmk_firmware/pull/8957 "Migrate `ACTION_MODS_ONESHOT` to `OSM()`"), [#8958](https://github.com/qmk/qmk_firmware/pull/8958 "Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()`"), [#8959](https://github.com/qmk/qmk_firmware/pull/8959 "Migrate `ACTION_LAYER_MODS` to `LM()`"), [#8968](https://github.com/qmk/qmk_firmware/pull/8968 "Migrate `ACTION_MODS_TAP_KEY` to `MT()`"), [#8977](https://github.com/qmk/qmk_firmware/pull/8977 "Migrate miscellaneous `fn_actions` entries"), and [#8979](https://github.com/qmk/qmk_firmware/pull/8979 "Migrate `ACTION_MODS_KEY` to chained mod keycodes")
-
-Authored by fauxpark, these pull requests remove references to deprecated TMK macros that have been superseded by native QMK keycodes.
-
-Old `fn_actions` action | New QMK keycode
-:---------------------- | :--------------
-`ACTION_DEFAULT_LAYER_SET(layer)` | `DF(layer)`
-`ACTION_LAYER_MODS(layer, mod)` | `LM(layer, mod)`
-`ACTION_LAYER_ONESHOT(mod)` | `OSL(mod)`
-`ACTION_LAYER_TOGGLE(layer)` | `TG(layer)`
-`ACTION_MODS_ONESHOT(mod)` | `OSM(mod)`
-`ACTION_MODS_TAP_KEY(mod, kc)` | `MT(mod, kc)`
-`ACTION_MODS_KEY(mod, kc)`<br>e.g. `ACTION_MODS_KEY(MOD_LCTL, KC_0)` | `MOD(kc)`<br>e.g. `LCTL(KC_0)`

docs/ChangeLog/20200829.md

@@ -1,148 +0,0 @@
-# QMK Breaking Change - 2020 Aug 29 Changelog
-
-Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
-
-
-## Changes Requiring User Action :id=changes-requiring-user-action
-
-### Relocated Keyboards :id-relocated-keyboards
-
-#### The Key Company project consolidation ([#9547](https://github.com/qmk/qmk_firmware/pull/9547))
-#### relocating boards by flehrad to flehrad/ folder ([#9635](https://github.com/qmk/qmk_firmware/pull/9635))
-
-Keyboards released by The Key Company and keyboards designed by flehrad have moved to vendor folders. If you own any of the keyboards listed below, please use the new names to compile your firmware moving forward.
-
-Old Name               | New Name
-:--------------------- | :------------------
-candybar/lefty         | tkc/candybar/lefty
-candybar/righty        | tkc/candybar/righty
-m0lly                  | tkc/m0lly
-tkc1800                | tkc/tkc1800
-bigswitch              | flehrad/bigswitch
-handwired/downbubble   | flehrad/downbubble
-handwired/numbrero     | flehrad/numbrero
-snagpad                | flehrad/snagpad
-handwired/tradestation | flehrad/tradestation
-
-### Updated Keyboard Codebases :id=keyboard-updates
-
-#### Keebio RGB wiring update ([#7754](https://github.com/qmk/qmk_firmware/pull/7754))
-
-This pull request changes the configuration for Keebio split boards to use the same RGB strip wiring for each half, which provides the following improvements:
-
-* Easier wiring due to one fewer wire needed (the wire between left DOut to extra data pin) and the fact that wiring is the same for both halves.
-* RGB LEDs can be controlled by each half now instead of just master half.
-* Extra data line is freed up to allow for I2C usage instead of serial.
-
-If you have customized the value of `RGBLED_SPLIT` for your keymap, you will need to undefine it using `#undef RGBLED_SPLIT` before defining it to your customized value.
-
-This change affects:
-
-* BFO-9000
-* Fourier
-* Iris rev2
-* Levinson, revs. 1 and 2
-* Nyquist, revs. 1 and 2
-* Quefrency rev1
-* Viterbi, revs. 1 and 2
-
-### Changes to Core Functionality :id=core-updates
-
-* Bigger Combo index ([#9318](https://github.com/qmk/qmk_firmware/pull/9318))
-
-Allows the Combo feature to support more than 256 combos.
-
-Any fork that uses `process_combo_event` needs to update the function's first argument to `uint16_t`:
-
-* Old function: `void process_combo_event(uint8_t combo_index, bool pressed)`
-* New function: `void process_combo_event(uint16_t combo_index, bool pressed)`
-
-
-## Core Changes :id=core-changes
-
-### Fixes :id=core-fixes
-
-* Mousekeys: scrolling acceleration is no longer coupled to mouse movement acceleration ([#9174](https://github.com/qmk/qmk_firmware/pull/9174))
-* Keymap Extras: correctly assign Question Mark in Czech layout ([#9987](https://github.com/qmk/qmk_firmware/pull/9987))
-
-### Additions and Enhancements :id=core-additions
-
-* allow for WS2812 PWM to work on DMAMUX-capable devices ([#9471](https://github.com/qmk/qmk_firmware/pull/9471))
-  * Newer STM32 MCUs have a DMAMUX peripheral, which allows mapping of DMAs to different DMA streams, rather than hard-defining the target streams in silicon.
-  * Affects STM32L4+ devices, as well as the soon-to-be-supported-by-QMK STM32G4/H7 families.
-  * Tested on F303/Proton C (ChibiOS v19, non-DMAMUX), G474 (ChibiOS v20, with DMAMUX).
-* dual-bank STM32 bootloader support ([#8778](https://github.com/qmk/qmk_firmware/pull/8778) and [#9738](https://github.com/qmk/qmk_firmware/pull/9738))
-  * Adds support for STM32 dual-bank flash bootloaders, by toggling a GPIO during early init in order to charge an RC circuit attached to `BOOT0`.
-  * The main rationale behind this is that dual-bank STM32 devices unconditionally execute user-mode code, regardless of whether or not the user-mode code jumps to the bootloader. If either flash bank is valid (and `BOOT0` is low), then the built-in bootloader will skip any sort of DFU.
-  * This PR allows for the initialisation sequencing to charge the RC circuit based on the example circuit posted on Discord, effectively pulling `BOOT0` high before issuing the system reset. As the RC circuit takes a while to discharge, the system reset executes the ROM bootloader which subsequently sees `BOOT0` high, and starts executing the DFU routines.
-  * Tested with STM32L082 (with current QMK+current ChibiOS), and STM32G474 (against ChibiOS 20.x).
-* update Space Cadet and Tap Dance features to use Custom Tapping Term when appropriate ([#6259](https://github.com/qmk/qmk_firmware/pull/6259))
-  * For the Tap Dance feature, this completely removes the need for the `ACTION_TAP_DANCE_FN_ADVANCED_TIME` dance.
-* HID Joystick Interface ([#4226](https://github.com/qmk/qmk_firmware/pull/4226) and [#9949](https://github.com/qmk/qmk_firmware/pull/9949 "Fix Joystick Compile Issues"))
-  * This implements a joystick feature, including a joystick_task function called from TMK, specific keycodes for joystick buttons and a USB HID interface.
-  * Tested on V-USB backend and Proton C; compiles but untested on LUFA.
-  * In order to test, you have to add `JOYSTICK_ENABLE = yes` to your `rules.mk` and
-    ```c
-    #define JOYSTICK_BUTTON_COUNT 8
-    #define JOYSTICK_AXES_COUNT 2
-    ```
-    in your config.h.
-* Christmas RGB Underglow animation now fades between green and red ([#7648](https://github.com/qmk/qmk_firmware/pull/7648))
-  * `RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL` has been greatly decreased; please check your animation if you have customized this value.
-* layer state now initializes on startup ([#8318](https://github.com/qmk/qmk_firmware/pull/8318))
-  * This should produce more consistent behavior between the two functions and layer masks.
-* added support for HSV->RGB conversion without using CIE curve ([#9856](https://github.com/qmk/qmk_firmware/pull/9856))
-* added NOEEPROM functions for RGB Matrix ([#9487](https://github.com/qmk/qmk_firmware/pull/9487))
-  * Added eeprom_helpers for toggle, mode, sethsv, speed, similar to rgblight versions.
-  * Added set_speed function.
-  * Added helper functions, similar to those in rgblight, in order to add NOEEPROM versions of toggle, step, hue, sat, val, and speed.
-  * Minor: spelling correction for EEPROM in a debug message.
-* flashing firmware using `st-flash` utility from [STLink Tools](https://github.com/stlink-org/stlink) is now supported ([#9964](https://github.com/qmk/qmk_firmware/pull/9964))
-* add ability to dump all makefile variables for the specified target ([#8256](https://github.com/qmk/qmk_firmware/pull/8256))
-  * Adds a new subtarget to builds, `dump_vars`, which allows for printing out all the variables that make knows about, after all substitutions occur.
-  * Example: `make handwired/onekey/proton_c:default:dump_vars`
-* add ability to change the Auto Shift timeout in real time ([#8441](https://github.com/qmk/qmk_firmware/pull/8441))
-* added a timer implementation for backlight on ChibiOS ([#8291](https://github.com/qmk/qmk_firmware/pull/8291))
-* added a third endpoint to V-USB keyboards ([#9020](https://github.com/qmk/qmk_firmware/pull/9020))
-* added a method to read the OLED display buffer from user space ([#8777](https://github.com/qmk/qmk_firmware/pull/8777))
-* K-Type refactor ([#9864](https://github.com/qmk/qmk_firmware/pull/9864))
-  * The K-Type has been refactored to use QMK's native matrix scanning routine, and now has partial support for the RGB Matrix feature.
-* Joysticks can now be used without defining analog pins ([#10169](https://github.com/qmk/qmk_firmware/pull/10169))
-
-### Clean-ups and Optimizations :id=core-optimizations
-
-* iWRAP protocol removed ([#9284](https://github.com/qmk/qmk_firmware/pull/9284))
-* work begun for consolidation of ChibiOS platform files ([#8327](https://github.com/qmk/qmk_firmware/pull/8327) and [#9315](https://github.com/qmk/qmk_firmware/pull/9315))
-  * Start of the consolidation work to move the ChibiOS board definitions as well as the default set of configuration files for existing board definitions used by keyboards.
-    * Uses `/platforms/chibios` as previously discussed on discord.
-    * Consolidates the Proton C configs into the generic F303 definitions.
-    * Allows for defining a default set of `chconf.h`, `halconf.h`, and `mcuconf.h` files within the platform definition, which is able to be overridden by the keyboard directly, though include path ordering.
-    * Adds template `chconf.h`, `halconf.h`, `mcuconf.h`, and `board.h` that can be dropped into a keyboard directory, in order to override rather than replace the entire contents of the respective files.
-    * Removed Proton C QMK board definitions, falling back to ChibiOS board definitions with QMK overrides.
-* Various tidy-ups for USB descriptor code ([#9005](https://github.com/qmk/qmk_firmware/pull/9005))
-  * Renamed `keyboard_led_stats` in lufa.c and ChibiOS usb_main.c to `keyboard_led_state`, as well as `vusb_keyboard_leds`, for consistency
-  * Formatted CDC and MIDI descriptors better
-  * Removed `ENDPOINT_CONFIG` macro, it seems pointless and removes the need for endpoint address defines in the middle of the endpoint numbering enum
-  * Fixed (possibly?) V-USB `GET_REPORT` request handling. Not sure about this one, but the existing code appears to always return an empty report - now `send_keyboard` sets this variable to the current report, matching what the LUFA code does.
-* converted `CONSUMER2BLUEFRUIT()` and `CONSUMER2RN42()` macros to static inline functions ([#9055](https://github.com/qmk/qmk_firmware/pull/9055))
-* Additional cleanups for V-USB code ([#9310](https://github.com/qmk/qmk_firmware/pull/9310))
-  * Removing the UART stuff entirely, now that we have Console support. Also fixing up various other things; switching some `debug()` calls to `dprintf()`, moved `raw_hid_report` out of the way so that we can implement the shared endpoint stuff.
-* removed inclusion of `adafruit_ble.h` from `ssd1306.c` ([#9355](https://github.com/qmk/qmk_firmware/pull/9355))
-* `outputselect.c` is no longer compiled if Bluetooth is disabled ([#9356](https://github.com/qmk/qmk_firmware/pull/9356))
-* `analogRead()` deprecated in favor of `analogReadPin()` ([#9023](https://github.com/qmk/qmk_firmware/pull/9023))
-* forcibly disable NKRO on V-USB controllers ([#9054](https://github.com/qmk/qmk_firmware/pull/9054))
-* removed warning if running backlight on STM32F072 ([#10040](https://github.com/qmk/qmk_firmware/pull/10040))
-* removed unused CORTEX_VTOR_INIT rules.mk option ([#10053](https://github.com/qmk/qmk_firmware/pull/10053))
-* improved handling for enabling Link Time Optimization ([#9832](https://github.com/qmk/qmk_firmware/pull/9832))
-* streamline rules for supporting Kiibohd bootloader ([#10129](https://github.com/qmk/qmk_firmware/pull/10129))
-* Define `STM32_DMA_REQUIRED` when using DMA-based WS2812 driver on STM32 ([#10127](https://github.com/qmk/qmk_firmware/pull/10127))
-* fix DMA stream ID calculation in ws2812_pwm ([#10008](https://github.com/qmk/qmk_firmware/pull/10008))
-* remove support for Adafruit EZ Key Bluetooth controller ([#10103](https://github.com/qmk/qmk_firmware/pull/10103))
-
-
-## QMK Infrastructure and Internals :id=qmk-internals
-
-* Attempt to fix CI for non-master branches. ([#9308](https://github.com/qmk/qmk_firmware/pull/9308))
-  * Actually fetch the branch we're attempting to compare against.
-* Run `qmk cformat` on `develop` branch ([#9501](https://github.com/qmk/qmk_firmware/pull/9501))
-* minor refactor of Bluetooth API ([#9905](https://github.com/qmk/qmk_firmware/pull/9905))

docs/README.md

@@ -9,35 +9,24 @@
 
 ## What is QMK Firmware?
 
-QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you.
+QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Toolbox, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
 
-## Get Started
+## How to Get It
 
-Totally new to QMK? There are two ways to get started:
+If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork.
 
-* Basic: [QMK Configurator](https://config.qmk.fm)
-    * Just select your keyboard from the dropdown and program your keyboard.
-    * We have an [introductory video](https://www.youtube.com/watch?v=-imgglzDMdY) you can watch.
-    * There is also an overview [document you can read](newbs_building_firmware_configurator.md).
-* Advanced: [Use The Source](newbs.md)
-    * More powerful, but harder to use
+Otherwise, you can clone it directly with `git clone https://github.com/qmk/qmk_firmware`. Do not download the zip or tar files; a git repository is required to download the submodules in order to compile.
 
-## Make It Yours
+## How to Compile
 
-QMK has lots of [features](features.md) to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).
+Before you are able to compile, you'll need to [install an environment](getting_started_build_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation:
 
-## Need help?
+    make planck/rev4:default
 
-Check out the [support page](support.md) to see how you can get help using QMK.
+This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted:
 
-## Give Back
+    make preonic:default
 
-There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.
+## How to Customize
 
-* Help people out on our forums and chat rooms:
-    * [/r/olkb](https://www.reddit.com/r/olkb/)
-    * [Discord Server](https://discord.gg/Uq7gcHh)
-* Contribute to our documentation by clicking "Edit This Page" at the bottom
-* [Translate our documentation into your language](translating.md)
-* [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose)
-* [Open a Pull Request](contributing.md)
+QMK has lots of [features](features.md) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).

docs/_summary.md

@@ -1,177 +1,130 @@
-* Tutorial
-  * [Introduction](newbs.md)
-  * [Setup](newbs_getting_started.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)
-  * [Getting Help/Support](support.md)
-  * [Other Resources](newbs_learn_more_resources.md)
-  * [Syllabus](syllabus.md)
+  * [Best Git Practices](newbs_git_best_practices.md)
+    * [Using Your Fork's Master](newbs_git_using_your_master_branch.md)
+    * [Resolving Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
+    * [Resynchronizing a Branch](newbs_git_resynchronize_a_branch.md)
+  * [Learning Resources](newbs_learn_more_resources.md)
 
-* FAQs
+* [QMK Basics](README.md)
+  * [QMK Introduction](getting_started_introduction.md)
+  * [QMK CLI](cli.md)
+  * [QMK CLI Config](cli_configuration.md)
+  * [Contributing to QMK](contributing.md)
+  * [How to Use Github](getting_started_github.md)
+  * [Getting Help](getting_started_getting_help.md)
+
+* [Breaking Changes](breaking_changes.md)
+  * [My Pull Request Was Flagged](breaking_changes_instructions.md)
+  * [2019 Aug 30](ChangeLog/20190830.md)
+
+* [FAQ](faq.md)
   * [General FAQ](faq_general.md)
   * [Build/Compile QMK](faq_build.md)
   * [Debugging/Troubleshooting QMK](faq_debug.md)
-  * [Keymap FAQ](faq_keymap.md)
+  * [Keymap](faq_keymap.md)
+  * [Driver Installation with Zadig](driver_installation_zadig.md)
+
+* Detailed Guides
+  * [Install Build Tools](getting_started_build_tools.md)
+  * [Vagrant Guide](getting_started_vagrant.md)
+  * [Build/Compile Instructions](getting_started_make_guide.md)
+  * [Flashing Firmware](flashing.md)
+  * [Customizing Functionality](custom_quantum_functions.md)
+  * [Keymap Overview](keymap.md)
+
+* [Hardware](hardware.md)
+  * [Compatible Microcontrollers](compatible_microcontrollers.md)
+  * [AVR Processors](hardware_avr.md)
+  * [Drivers](hardware_drivers.md)
+
+* Reference
+  * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
+  * [Config Options](config_options.md)
+  * [Keycodes](keycodes.md)
+  * [Coding Conventions - C](coding_conventions_c.md)
+  * [Coding Conventions - Python](coding_conventions_python.md)
+  * [Documentation Best Practices](documentation_best_practices.md)
+  * [Documentation Templates](documentation_templates.md)
   * [Glossary](reference_glossary.md)
+  * [Unit Testing](unit_testing.md)
+  * [Useful Functions](ref_functions.md)
+  * [Configurator Support](reference_configurator_support.md)
+  * [info.json Format](reference_info_json.md)
+  * [Python CLI Development](cli_development.md)
 
-* Configurator
-  * [Overview](newbs_building_firmware_configurator.md)
-  * [Step by Step](configurator_step_by_step.md)
-  * [Troubleshooting](configurator_troubleshooting.md)
-  * QMK API
-    * [Overview](api_overview.md)
-    * [API Documentation](api_docs.md)
-    * [Keyboard Support](reference_configurator_support.md)
+* [Features](features.md)
+  * [Basic Keycodes](keycodes_basic.md)
+  * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
+  * [Quantum Keycodes](quantum_keycodes.md)
+  * [Advanced Keycodes](feature_advanced_keycodes.md)
+  * [Audio](feature_audio.md)
+  * [Auto Shift](feature_auto_shift.md)
+  * [Backlight](feature_backlight.md)
+  * [Bluetooth](feature_bluetooth.md)
+  * [Bootmagic](feature_bootmagic.md)
+  * [Combos](feature_combo.md)
+  * [Command](feature_command.md)
+  * [Debounce API](feature_debounce_type.md)
+  * [DIP Switch](feature_dip_switch.md)
+  * [Dynamic Macros](feature_dynamic_macros.md)
+  * [Encoders](feature_encoders.md)
+  * [Grave Escape](feature_grave_esc.md)
+  * [Haptic Feedback](feature_haptic_feedback.md)
+  * [HD44780 LCD Controller](feature_hd44780.md)
+  * [Key Lock](feature_key_lock.md)
+  * [Layouts](feature_layouts.md)
+  * [Leader Key](feature_leader_key.md)
+  * [LED Matrix](feature_led_matrix.md)
+  * [Macros](feature_macros.md)
+  * [Mouse Keys](feature_mouse_keys.md)
+  * [OLED Driver](feature_oled_driver.md)
+  * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
+  * [Pointing Device](feature_pointing_device.md)
+  * [PS/2 Mouse](feature_ps2_mouse.md)
+  * [RGB Lighting](feature_rgblight.md)
+  * [RGB Matrix](feature_rgb_matrix.md)
+  * [Space Cadet](feature_space_cadet.md)
+  * [Split Keyboard](feature_split_keyboard.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)
+  * [Unicode](feature_unicode.md)
+  * [Userspace](feature_userspace.md)
+  * [Velocikey](feature_velocikey.md)
 
-* CLI
-    * [Overview](cli.md)
-    * [Configuration](cli_configuration.md)
-    * [Commands](cli_commands.md)
+* For Makers and Modders
+  * [Hand Wiring Guide](hand_wire.md)
+  * [ISP Flashing Guide](isp_flashing_guide.md)
+  * [ARM Debugging Guide](arm_debugging.md)
+  * [ADC Driver](adc_driver.md)
+  * [I2C Driver](i2c_driver.md)
+  * [WS2812 Driver](ws2812_driver.md)
+  * [EEPROM Driver](eeprom_driver.md)
+  * [GPIO Controls](internals_gpio_control.md)
+  * [Custom Matrix](custom_matrix.md)
+  * [Proton C Conversion](proton_c_conversion.md)
 
-* Using QMK
-  * Guides
-    * [Customizing Functionality](custom_quantum_functions.md)
-    * [Driver Installation with Zadig](driver_installation_zadig.md)
-    * [Keymap Overview](keymap.md)
-    * Development Environments
-      * [Docker Guide](getting_started_docker.md)
-      * [Vagrant Guide](getting_started_vagrant.md)
-    * Flashing
-      * [Flashing](flashing.md)
-      * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md)
-    * IDEs
-      * [Using Eclipse with QMK](other_eclipse.md)
-      * [Using VSCode with QMK](other_vscode.md)
-    * Git Best Practices
-      * [Introduction](newbs_git_best_practices.md)
-      * [Your Fork](newbs_git_using_your_master_branch.md)
-      * [Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
-      * [Fixing Your Branch](newbs_git_resynchronize_a_branch.md)
-    * Keyboard Building
-      * [Hand Wiring Guide](hand_wire.md)
-      * [ISP Flashing Guide](isp_flashing_guide.md)
+* For a Deeper Understanding
+  * [How Keyboards Work](how_keyboards_work.md)
+  * [Understanding QMK](understanding_qmk.md)
 
-  * Simple Keycodes
-    * [Full List](keycodes.md)
-    * [Basic Keycodes](keycodes_basic.md)
-    * [Language-Specific Keycodes](reference_keymap_extras.md)
-    * [Modifier Keys](feature_advanced_keycodes.md)
-    * [Quantum Keycodes](quantum_keycodes.md)
+* Other Topics
+  * [Using Eclipse with QMK](other_eclipse.md)
+  * [Using VSCode with QMK](other_vscode.md)
+  * [Support](support.md)
+  * [Translating the QMK Docs](translating.md)
 
-  * Advanced Keycodes
-    * [Command](feature_command.md)
-    * [Dynamic Macros](feature_dynamic_macros.md)
-    * [Grave Escape](feature_grave_esc.md)
-    * [Leader Key](feature_leader_key.md)
-    * [Mod-Tap](mod_tap.md)
-    * [Macros](feature_macros.md)
-    * [Mouse Keys](feature_mouse_keys.md)
-    * [Space Cadet Shift](feature_space_cadet.md)
-    * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
-
-  * Software Features
-    * [Auto Shift](feature_auto_shift.md)
-    * [Combos](feature_combo.md)
-    * [Debounce API](feature_debounce_type.md)
-    * [Key Lock](feature_key_lock.md)
-    * [Layers](feature_layers.md)
-    * [One Shot Keys](one_shot_keys.md)
-    * [Pointing Device](feature_pointing_device.md)
-    * [Raw HID](feature_rawhid.md)
-    * [Swap Hands](feature_swap_hands.md)
-    * [Tap Dance](feature_tap_dance.md)
-    * [Tap-Hold Configuration](tap_hold.md)
-    * [Terminal](feature_terminal.md)
-    * [Unicode](feature_unicode.md)
-    * [Userspace](feature_userspace.md)
-    * [WPM Calculation](feature_wpm.md)
-
-  * Hardware Features
-    * Displays
-      * [HD44780 LCD Controller](feature_hd44780.md)
-      * [OLED Driver](feature_oled_driver.md)
-    * Lighting
-      * [Backlight](feature_backlight.md)
-      * [LED Matrix](feature_led_matrix.md)
-      * [RGB Lighting](feature_rgblight.md)
-      * [RGB Matrix](feature_rgb_matrix.md)
-    * [Audio](feature_audio.md)
-    * [Bluetooth](feature_bluetooth.md)
-    * [Bootmagic](feature_bootmagic.md)
-    * [Custom Matrix](custom_matrix.md)
-    * [DIP Switch](feature_dip_switch.md)
-    * [Encoders](feature_encoders.md)
-    * [Haptic Feedback](feature_haptic_feedback.md)
-    * [Joystick](feature_joystick.md)
-    * [Proton C Conversion](proton_c_conversion.md)
-    * [PS/2 Mouse](feature_ps2_mouse.md)
-    * [Split Keyboard](feature_split_keyboard.md)
-    * [Stenography](feature_stenography.md)
-    * [Thermal Printer](feature_thermal_printer.md)
-    * [Velocikey](feature_velocikey.md)
-
-* Developing QMK
-  * [PR Checklist](pr_checklist.md)
-  * Breaking Changes
-    * [Overview](breaking_changes.md)
-    * [My Pull Request Was Flagged](breaking_changes_instructions.md)
-    * History
-      * [2020 May 30](ChangeLog/20200530.md)
-      * [2020 Feb 29](ChangeLog/20200229.md)
-      * [2019 Aug 30](ChangeLog/20190830.md)
-
-  * C Development
-    * [ARM Debugging Guide](arm_debugging.md)
-    * [AVR Processors](hardware_avr.md)
-    * [Coding Conventions](coding_conventions_c.md)
-    * [Compatible Microcontrollers](compatible_microcontrollers.md)
-    * [Drivers](hardware_drivers.md)
-      * [ADC Driver](adc_driver.md)
-      * [I2C Driver](i2c_driver.md)
-      * [SPI Driver](spi_driver.md)
-      * [WS2812 Driver](ws2812_driver.md)
-      * [EEPROM Driver](eeprom_driver.md)
-      * ['serial' Driver](serial_driver.md)
-    * [GPIO Controls](internals_gpio_control.md)
-    * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
-
-  * Python Development
-    * [Coding Conventions](coding_conventions_python.md)
-    * [QMK CLI Development](cli_development.md)
-
-  * Configurator Development
-    * QMK API
-      * [Development Environment](api_development_environment.md)
-      * [Architecture Overview](api_development_overview.md)
-
-  * Hardware Platform Development
-    * Arm/ChibiOS
-      * [Selecting an MCU](platformdev_selecting_arm_mcu.md)
-      * [Early initialization](platformdev_chibios_earlyinit.md)
-
-  * QMK Reference
-    * [Contributing to QMK](contributing.md)
-    * [Translating the QMK Docs](translating.md)
-    * [Config Options](config_options.md)
-    * [Make Documentation](getting_started_make_guide.md)
-    * [Documentation Best Practices](documentation_best_practices.md)
-    * [Documentation Templates](documentation_templates.md)
-    * [Community Layouts](feature_layouts.md)
-    * [Unit Testing](unit_testing.md)
-    * [Useful Functions](ref_functions.md)
-    * [info.json Format](reference_info_json.md)
-
-  * For a Deeper Understanding
-    * [How Keyboards Work](how_keyboards_work.md)
-    * [How a Matrix Works](how_a_matrix_works.md)
-    * [Understanding QMK](understanding_qmk.md)
-
-  * QMK Internals (In Progress)
-    * [Defines](internals_defines.md)
-    * [Input Callback Reg](internals_input_callback_reg.md)
-    * [Midi Device](internals_midi_device.md)
-    * [Midi Device Setup Process](internals_midi_device_setup_process.md)
-    * [Midi Util](internals_midi_util.md)
-    * [Send Functions](internals_send_functions.md)
-    * [Sysex Tools](internals_sysex_tools.md)
+* QMK Internals (In Progress)
+  * [Defines](internals_defines.md)
+  * [Input Callback Reg](internals_input_callback_reg.md)
+  * [Midi Device](internals_midi_device.md)
+  * [Midi Device Setup Process](internals_midi_device_setup_process.md)
+  * [Midi Util](internals_midi_util.md)
+  * [Send Functions](internals_send_functions.md)
+  * [Sysex Tools](internals_sysex_tools.md)

docs/adc_driver.md

@@ -2,7 +2,7 @@
 
 QMK can leverage the Analog-to-Digital Converter (ADC) on supported MCUs to measure voltages on certain pins. This can be useful for implementing things such as battery level indicators for Bluetooth keyboards, or volume controls using a potentiometer, as opposed to a [rotary encoder](feature_encoders.md).
 
-This driver currently supports both AVR and a limited selection of ARM devices. The values returned are 10-bit integers (0-1023) mapped between 0V and VCC (usually 5V or 3.3V for AVR, 3.3V only for ARM), however on ARM there is more flexibility in control of operation through `#define`s if you need more precision.
+This driver is currently AVR-only. The values returned are 10-bit integers (0-1023) mapped between 0V and VCC (usually 5V or 3.3V).
 
 ## Usage
 
@@ -20,9 +20,7 @@ Then place this include at the top of your code:
 
 ## Channels
 
-### AVR
-
-|Channel|AT90USB64/128|ATmega16/32U4|ATmega32A|ATmega328/P|
+|Channel|AT90USB64/128|ATmega16/32U4|ATmega32A|ATmega328P|
 |-------|-------------|-------------|---------|----------|
 |0      |`F0`         |`F0`         |`A0`     |`C0`      |
 |1      |`F1`         |`F1`         |`A1`     |`C1`      |
@@ -39,112 +37,14 @@ Then place this include at the top of your code:
 |12     |             |`B5`         |         |          |
 |13     |             |`B6`         |         |          |
 
-<sup>\* The ATmega328/P possesses two extra ADC channels; however, they are not present on the DIP pinout, and are not shared with GPIO pins. You can use `adc_read()` directly to gain access to these.</sup>
-
-### ARM
-
-Note that some of these pins are doubled-up on ADCs with the same channel. This is because the pins can be used for either ADC.
-
-Also note that the F0 and F3 use different numbering schemes. The F0 has a single ADC and the channels are 0-indexed, whereas the F3 has 4 ADCs and the channels are 1-indexed. This is because the F0 uses the `ADCv1` implementation of the ADC, whereas the F3 uses the `ADCv3` implementation.
-
-|ADC|Channel|STM32F0xx|STM32F3xx|
-|---|-------|---------|---------|
-|1  |0      |`A0`     |         |
-|1  |1      |`A1`     |`A0`     |
-|1  |2      |`A2`     |`A1`     |
-|1  |3      |`A3`     |`A2`     |
-|1  |4      |`A4`     |`A3`     |
-|1  |5      |`A5`     |`F4`     |
-|1  |6      |`A6`     |`C0`     |
-|1  |7      |`A7`     |`C1`     |
-|1  |8      |`B0`     |`C2`     |
-|1  |9      |`B1`     |`C3`     |
-|1  |10     |`C0`     |`F2`     |
-|1  |11     |`C1`     |         |
-|1  |12     |`C2`     |         |
-|1  |13     |`C3`     |         |
-|1  |14     |`C4`     |         |
-|1  |15     |`C5`     |         |
-|1  |16     |         |         |
-|2  |1      |         |`A4`     |
-|2  |2      |         |`A5`     |
-|2  |3      |         |`A6`     |
-|2  |4      |         |`A7`     |
-|2  |5      |         |`C4`     |
-|2  |6      |         |`C0`     |
-|2  |7      |         |`C1`     |
-|2  |8      |         |`C2`     |
-|2  |9      |         |`C3`     |
-|2  |10     |         |`F2`     |
-|2  |11     |         |`C5`     |
-|2  |12     |         |`B2`     |
-|2  |13     |         |         |
-|2  |14     |         |         |
-|2  |15     |         |         |
-|2  |16     |         |         |
-|3  |1      |         |`B1`     |
-|3  |2      |         |`E9`     |
-|3  |3      |         |`E13`    |
-|3  |4      |         |         |
-|3  |5      |         |         |
-|3  |6      |         |`E8`     |
-|3  |7      |         |`D10`    |
-|3  |8      |         |`D11`    |
-|3  |9      |         |`D12`    |
-|3  |10     |         |`D13`    |
-|3  |11     |         |`D14`    |
-|3  |12     |         |`B0`     |
-|3  |13     |         |`E7`     |
-|3  |14     |         |`E10`    |
-|3  |15     |         |`E11`    |
-|3  |16     |         |`E12`    |
-|4  |1      |         |`E14`    |
-|4  |2      |         |`B12`    |
-|4  |3      |         |`B13`    |
-|4  |4      |         |`B14`    |
-|4  |5      |         |`B15`    |
-|4  |6      |         |`E8`     |
-|4  |7      |         |`D10`    |
-|4  |8      |         |`D11`    |
-|4  |9      |         |`D12`    |
-|4  |10     |         |`D13`    |
-|4  |11     |         |`D14`    |
-|4  |12     |         |`D8`     |
-|4  |13     |         |`D9`     |
-|4  |14     |         |         |
-|4  |15     |         |         |
-|4  |16     |         |         |
+<sup>\* The ATmega328P possesses two extra ADC channels; however, they are not present on the DIP pinout, and are not shared with GPIO pins. You can use `adc_read()` directly to gain access to these.</sup>
 
 ## Functions
 
-### AVR
-
 |Function                    |Description                                                                                                        |
 |----------------------------|-------------------------------------------------------------------------------------------------------------------|
 |`analogReference(mode)`     |Sets the analog voltage reference source. Must be one of `ADC_REF_EXTERNAL`, `ADC_REF_POWER` or `ADC_REF_INTERNAL`.|
-|`analogReadPin(pin)`        |Reads the value from the specified pin, eg. `F6` for ADC6 on the ATmega32U4.                                       |
-|`pinToMux(pin)`             |Translates a given pin to a mux value. If an unsupported pin is given, returns the mux value for "0V (GND)".       |
+|`analogRead(pin)`           |Reads the value from the specified Arduino pin, eg. `4` for ADC6 on the ATmega32U4.                                |
+|`analogReadPin(pin)`        |Reads the value from the specified QMK pin, eg. `F6` for ADC6 on the ATmega32U4.                                   |
+|`pinToMux(pin)`             |Translates a given QMK pin to a mux value. If an unsupported pin is given, returns the mux value for "0V (GND)".   |
 |`adc_read(mux)`             |Reads the value from the ADC according to the specified mux. See your MCU's datasheet for more information.        |
-
-### ARM
-
-|Function                    |Description                                                                                                                                                                                                                                                                                           |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-|`analogReadPin(pin)`        |Reads the value from the specified pin, eg. `A0` for channel 0 on the STM32F0 and ADC1 channel 1 on the STM32F3. Note that if a pin can be used for multiple ADCs, it will pick the lower numbered ADC for this function. eg. `C0` will be channel 6 of ADC 1 when it could be used for ADC 2 as well.|
-|`analogReadPinAdc(pin, adc)`|Reads the value from the specified pin and ADC, eg. `C0, 1` will read from channel 6, ADC 2 instead of ADC 1. Note that the ADCs are 0-indexed for this function.                                                                                                                                     |
-|`pinToMux(pin)`             |Translates a given pin to a channel and ADC combination. If an unsupported pin is given, returns the mux value for "0V (GND)".                                                                                                                                                                        |
-|`adc_read(mux)`             |Reads the value from the ADC according to the specified pin and ADC combination. See your MCU's datasheet for more information.                                                                                                                                                                       |
-
-## Configuration
-
-## ARM
-
-The ARM implementation of the ADC has a few additional options that you can override in your own keyboards and keymaps to change how it operates. Please consult the corresponding `hal_adc_lld.h` in ChibiOS for your specific microcontroller for further documentation on your available options.
-
-|`#define`            |Type  |Default              |Description                                                                                                                                                                                                 |
-|---------------------|------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-|`ADC_CIRCULAR_BUFFER`|`bool`|`false`              |If `true`, then the implementation will use a circular buffer.                                                                                                                                              |
-|`ADC_NUM_CHANNELS`   |`int` |`1`                  |Sets the number of channels that will be scanned as part of an ADC operation. The current implementation only supports `1`.                                                                                 |
-|`ADC_BUFFER_DEPTH`   |`int` |`2`                  |Sets the depth of each result. Since we are only getting a 12-bit result by default, we set this to 2 bytes so we can contain our one value. This could be set to 1 if you opt for an 8-bit or lower result.|
-|`ADC_SAMPLING_RATE`  |`int` |`ADC_SMPR_SMP_1P5`   |Sets the sampling rate of the ADC. By default, it is set to the fastest setting.                                                                                                                            |
-|`ADC_RESOLUTION`     |`int` |`ADC_CFGR1_RES_12BIT`|The resolution of your result. We choose 12 bit by default, but you can opt for 12, 10, 8, or 6 bit.                                                                                                        |

docs/api_development_environment.md

@@ -1,3 +0,0 @@
-# Development Environment Setup
-
-To setup a development stack head over to the [qmk_web_stack](https://github.com/qmk/qmk_web_stack).

docs/api_development_overview.md

@@ -1,44 +0,0 @@
-# QMK Compiler Development Guide
-
-This page attempts to introduce developers to the QMK Compiler. It does not go into nitty gritty details- for that you should read code. What this will give you is a framework to hang your understanding on as you read the code.
-
-# Overview
-
-The QMK Compile API consists of a few movings parts:
-
-![Architecture Diagram](https://raw.githubusercontent.com/qmk/qmk_api/master/docs/architecture.svg)
-
-API Clients interact exclusively with the API service. This is where they submit jobs, check status, and download results. The API service inserts compile jobs into [Redis Queue](https://python-rq.org) and checks both RQ and S3 for the results of those jobs.
-
-Workers fetch new compile jobs from RQ, compile them, and then upload the source and the binary to an S3 compatible storage engine.
-
-# Workers
-
-QMK Compiler Workers are responsible for doing the actual building. When a worker pulls a job from RQ it does several things to complete that job:
-
-* Make a fresh qmk_firmware checkout
-* Use the supplied layers and keyboard metadata to build a `keymap.c`
-* Build the firmware
-* Zip a copy of the source
-* Upload the firmware, source zip, and a metadata file to S3.
-* Report the status of the job to RQ
-
-# API Service
-
-The API service is a relatively simple Flask application. There are a few main views you should understand.
-
-## @app.route('/v1/compile', methods=['POST'])
-
-This is the main entrypoint for the API. A client's interaction starts here. The client POST's a JSON document describing their keyboard, and the API does some (very) basic validation of that JSON before submitting the compile job.
-
-## @app.route('/v1/compile/<string:job_id>', methods=['GET'])
-
-This is the most frequently called endpoint. It pulls the job details from redis, if they're still available, or the cached job details on S3 if they're not.
-
-## @app.route('/v1/compile/<string:job_id>/download', methods=['GET'])
-
-This method allows users to download the compiled firmware file.
-
-## @app.route('/v1/compile/<string:job_id>/source', methods=['GET'])
-
-This method allows users to download the source for their firmware.

docs/api_docs.md

@@ -1,68 +0,0 @@
-# QMK API
-
-This page describes using the QMK API. If you are an application developer you can use this API to compile firmware for any [QMK](https://qmk.fm) Keyboard.
-
-## Overview
-
-This service is an asynchronous API for compiling custom keymaps. You POST some JSON to the API, periodically check the status, and when your firmware has finished compiling you can download the resulting firmware and (if desired) source code for that firmware.
-
-#### Example JSON Payload:
-
-```json
-{
-  "keyboard": "clueboard/66/rev2",
-  "keymap": "my_awesome_keymap",
-  "layout": "LAYOUT_all",
-  "layers": [
-    ["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_GRV","KC_BSPC","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_PGDN","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_NUHS","KC_ENT","KC_LSFT","KC_NUBS","KC_Z","KC_X","KC_C","KC_V","KC_B","KC_N","KC_M","KC_COMM","KC_DOT","KC_SLSH","KC_RO","KC_RSFT","KC_UP","KC_LCTL","KC_LGUI","KC_LALT","KC_MHEN","KC_SPC","KC_SPC","KC_HENK","KC_RALT","KC_RCTL","MO(1)","KC_LEFT","KC_DOWN","KC_RIGHT"],
-    ["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_TRNS","KC_DEL","BL_STEP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","_______","KC_TRNS","KC_PSCR","KC_SLCK","KC_PAUS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","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_PGUP","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_LEFT","KC_PGDN","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_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","RESET","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(2)","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","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","KC_TRNS","MO(1)","KC_TRNS","KC_TRNS","KC_TRNS"]
-  ]
-}
-```
-
-As you can see the payload describes all aspects of a keyboard necessary to create and generate a firmware. Each layer is a single list of QMK keycodes the same length as the keyboard's `LAYOUT` macro. If a keyboard supports mulitple `LAYOUT` macros you can specify which macro to use.
-
-## Submitting a Compile Job
-
-To compile your keymap into a firmware simply POST your JSON to the `/v1/compile` endpoint. In the following example we've placed the JSON payload into a file named `json_data`.
-
-```
-$ curl -H "Content-Type: application/json" -X POST -d "$(< json_data)" http://api.qmk.fm/v1/compile
-{
-  "enqueued": true,
-  "job_id": "ea1514b3-bdfc-4a7b-9b5c-08752684f7f6"
-}
-```
-
-## Checking The Status
-
-After submitting your keymap you can check the status using a simple HTTP GET call:
-
-```
-$ curl http://api.qmk.fm/v1/compile/ea1514b3-bdfc-4a7b-9b5c-08752684f7f6
-{
-  "created_at": "Sat, 19 Aug 2017 21:39:12 GMT",
-  "enqueued_at": "Sat, 19 Aug 2017 21:39:12 GMT",
-  "id": "f5f9b992-73b4-479b-8236-df1deb37c163",
-  "status": "running",
-  "result": null
-}
-```
-
-This shows us that the job has made it through the queue and is currently running. There are 5 possible statuses:
-
-* **failed**: Something about the compiling service has broken.
-* **finished**: The compilation is complete and you should check `result` to see the results.
-* **queued**: The keymap is waiting for a compilation server to become available.
-* **running**: The compilation is in progress and should be complete soon.
-* **unknown**: A serious error has occurred and you should [file a bug](https://github.com/qmk/qmk_compiler/issues).
-
-## Examining Finished Results
-
-Once your compile job has finished you'll check the `result` key. The value of this key is a hash containing several key bits of information:
-
-* `firmware_binary_url`: A list of URLs for the the flashable firmware
-* `firmware_keymap_url`: A list of URLs for the the `keymap.c`
-* `firmware_source_url`: A list of URLs for the full firmware source code
-* `output`: The stdout and stderr for this compile job. Errors will be found here.

docs/api_overview.md

@@ -1,15 +0,0 @@
-# QMK API
-
-The QMK API provides an asynchronous API that Web and GUI tools can use to compile arbitrary keymaps for any keyboard supported by [QMK](http://qmk.fm/). The stock keymap template supports all QMK keycodes that do not require supporting C code. Keyboard maintainers can supply their own custom templates to enable more functionality.
-
-## App Developers
-
-If you are an app developer interested in using this API in your application you should head over to [Using The API](api_docs.md).
-
-## Keyboard Maintainers
-
-If you would like to enhance your keyboard's support in the QMK Compiler API head over to the [Keyboard Support](reference_configurator_support.md) section.
-
-## Backend Developers
-
-If you are interested in working on the API itself you should start by setting up a [Development Environment](api_development_environment.md), then check out [Hacking On The API](api_development_overview.md).

docs/becoming_a_qmk_collaborator.md

@@ -0,0 +1,9 @@
+# Becoming a QMK Collaborator
+
+A QMK collaborator is a keyboard maker or designer that is interested in helping QMK grow and fully support their keyboard(s), and encouraging their users and customers to submit features, ideas, and keymaps. We're always looking to add more keyboards and collaborators, but we ask that they fulfill these requirements:
+
+* **Have a PCB available for sale.** Unfortunately there's just too much variation and complications with handwired keyboards.
+* **Maintain your keyboard in QMK.** This may just require an initial setup to get your keyboard working, but it could also include accommodating changes made to QMK's core that might break or render any custom code redundant.
+* **Approve and merge keymap pull requests for your keyboard.** We like to encourage users to contribute their keymaps for others to see and work from when creating their own.
+
+If you feel you meet these requirements, shoot us an email at hello@qmk.fm with an introduction and some links to your keyboard!

docs/breaking_changes.md

@@ -6,29 +6,27 @@ The breaking change period is when we will merge PR's that change QMK in dangero
 
 ## What has been included in past Breaking Changes?
 
-* [2020 Aug 29](ChangeLog/20200829.md)
-* [2020 May 30](ChangeLog/20200530.md)
 * [2020 Feb 29](ChangeLog/20200229.md)
 * [2019 Aug 30](ChangeLog/20190830.md)
 
 ## When is the next Breaking Change?
 
-The next Breaking Change is scheduled for November 28, 2020.
+The next Breaking Change is scheduled for May 30, 2020.
 
 ### Important Dates
 
-* [x] 2020 Aug 29 - `develop` is created. It will be rebased weekly.
-* [ ] 2020 Oct 31 - `develop` closed to new PR's.
-* [ ] 2020 Oct 31 - Call for testers.
-* [ ] 2020 Nov 26 - `master` is locked, no PR's merged.
-* [ ] 2020 Nov 28 - Merge `develop` to `master`.
-* [ ] 2020 Nov 28 - `master` is unlocked. PR's can be merged again.
+* [x] 2020 Feb 29 - `future` is created. It will be rebased weekly.
+* [ ] 2020 May 2 - `future` closed to new PR's.
+* [ ] 2020 May 2 - Call for testers.
+* [ ] 2020 May 28 - `master` is locked, no PR's merged.
+* [ ] 2020 May 30 - Merge `future` to `master`.
+* [ ] 2020 May 30 - `master` is unlocked. PR's can be merged again.
 
 ## What changes will be included?
 
-To see a list of breaking change candidates you can look at the [`breaking_change` label](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). New changes might be added between now and when `develop` is closed, and a PR with that label applied is not guaranteed to be merged.
+To see a list of breaking change candidates you can look at the [`breaking_change` label](https://github.com/qmk/qmk_firmware/pulls?q=is%3Aopen+label%3Abreaking_change+is%3Apr). New changes might be added between now and when `future` is closed, and a PR with that label applied is not guaranteed to be merged.
 
-If you want your breaking change to be included in this round you need to create a PR with the `breaking_change` label and have it accepted before `develop` closes. After `develop` closes no new breaking changes will be accepted.
+If you want your breaking change to be included in this round you need to create a PR with the `breaking_change` label and have it accepted before `future` closes. After `future` closes no new breaking changes will be accepted.
 
 Criteria for acceptance:
 
@@ -39,9 +37,9 @@ Criteria for acceptance:
 
 This section documents various processes we use when running the Breaking Changes process.
 
-## Rebase `develop` from `master`
+## Rebase `future` from `master`
 
-This is run every Friday while `develop` is open.
+This is run every Friday while `future` is open.
 
 Process:
 
@@ -49,31 +47,31 @@ Process:
 cd qmk_firmware
 git checkout master
 git pull --ff-only
-git checkout develop
+git checkout future
 git rebase master
 git push --force
 ```
 
-## Creating the `develop` branch
+## Creating the `future` branch
 
-This happens immediately after the previous `develop` branch is merged.
+This happens immediately after the previous `future` branch is merged.
 
 * `qmk_firmware` git commands
     * [ ] `git checkout master`
     * [ ] `git pull --ff-only`
-    * [ ] `git checkout -b develop`
+    * [ ] `git checkout -b future`
     * [ ] Edit `readme.md`
         * [ ] Add a big notice at the top that this is a testing branch.
         * [ ] Include a link to this document
     * [ ] `git commit -m 'Branch point for <DATE> Breaking Change'`
     * [ ] `git tag breakpoint_<YYYY>_<MM>_<DD>`
     * [ ] `git tag <next_version>` # Prevent the breakpoint tag from confusing version incrementing
-    * [ ] `git push origin develop`
+    * [ ] `git push origin future`
     * [ ] `git push --tags`
 
 ## 4 Weeks Before Merge
 
-* `develop` is now closed to new PR's, only fixes for current PR's may be merged
+* `future` is now closed to new PR's, only fixes for current PR's may be merged
 * Post call for testers
     * [ ] Discord
     * [ ] GitHub PR
@@ -96,15 +94,15 @@ This happens immediately after the previous `develop` branch is merged.
 ## Day Of Merge
 
 * `qmk_firmware` git commands
-    * [ ] `git checkout develop`
+    * [ ] `git checkout future`
     * [ ] `git pull --ff-only`
     * [ ] `git rebase origin/master`
     * [ ] Edit `readme.md`
-        * [ ] Remove the notes about `develop`
+        * [ ] Remove the notes about `future`
     * [ ] Roll up the ChangeLog into one file.
     * [ ] `git commit -m 'Merge point for <DATE> Breaking Change'`
-    * [ ] `git push origin develop`
-* GitHub Actions
-    * [ ] Create a PR for `develop`
+    * [ ] `git push origin future`
+* Github Actions
+    * [ ] Create a PR for `future`
     * [ ] Make sure travis comes back clean
-    * [ ] Merge `develop` PR
+    * [ ] Merge `future` PR