Complete Newbs Guide

• Getting Started
• Building Your First Firmware
• Flashing Firmware
• Testing and Debugging
• Git Best Practices
• Learning Resources

QMK Basics

• QMK Introduction
• QMK CLI
• QMK CLI Config
• Contributing to QMK
• How to Use GitHub
• Getting Help

Breaking Changes

• 2019 Aug 30

FAQ

• General FAQ
• Build/Compile QMK
• Debugging/Troubleshooting QMK
• Keymap
• Driver Installation with Zadig

Detailed Guides

• Install Build Tools
• Vagrant Guide
• Build/Compile Instructions
• Flashing Firmware
• Customizing Functionality
• Keymap Overview

Hardware

• Compatible Microcontrollers
• AVR Processors
• Drivers

Reference

• Keyboard Guidelines
• Config Options
• Keycodes
• Coding Conventions - C
• Coding Conventions - Python
• Documentation Best Practices
• Documentation Templates
• Glossary
• Unit Testing
• Useful Functions
• Configurator Support
• info.json Format
• Python CLI Development

Features

• Basic Keycodes
• US ANSI Shifted Keys
• Quantum Keycodes
• Advanced Keycodes
• Audio
• Auto Shift
• Backlight
• Bluetooth
• Bootmagic
• Combos
• Command
• Debounce API
• DIP Switch
• Dynamic Macros
• Encoders
• Grave Escape
• Haptic Feedback
• HD44780 LCD Controller
• Key Lock
• Layouts
• Leader Key
• LED Matrix
• Macros
• Mouse Keys
• OLED Driver
• One Shot Keys
• Pointing Device
• PS/2 Mouse
• RGB Lighting
• RGB Matrix
• Space Cadet
• Split Keyboard
• Stenography
• Swap Hands
• Tap Dance
• Terminal
• Thermal Printer
• Unicode
• Userspace
• Velocikey

For Makers and Modders

• Hand Wiring Guide
• ISP Flashing Guide
• ARM Debugging Guide
• I2C Driver
• SPI Driver
• WS2812 Driver
• GPIO Controls
• Proton C Conversion

For a Deeper Understanding

• How Keyboards Work
• Understanding QMK

Other Topics

• Using Eclipse with QMK
• Using VSCode with QMK
• Support
• Translating the QMK Docs

QMK Internals (In Progress)

• Defines
• Input Callback Reg
• Midi Device
• Midi Device Setup Process
• Midi Util
• Send Functions
• Sysex Tools