qmk-firmwares/docs/_summary.md at af5fe7fb75a5ca7592a32aba21ed025cf9c4e192 - nicd/qmk-firmwares - T:mi AhlCode

nicd/qmk-firmwares

Ryan 75544d9127

Move Doxygen docs to subdirectory (#16561 )

2022-03-07 11:22:22 +00:00

7.2 KiB

Raw Blame History

Tutorial
FAQs
Configurator
- Overview
- Step by Step
- Troubleshooting
- Architecture
- QMK API
CLI
Using QMK
- Guides
  - Customizing Functionality
  - Driver Installation with Zadig
  - Keymap Overview
  - Development Environments
    - Docker Guide
    - Vagrant Guide
  - Flashing
    - Flashing
    - Flashing ATmega32A (ps2avrgb)
  - IDEs
    - Using Eclipse with QMK
    - Using VSCode with QMK
  - Git Best Practices
- Simple Keycodes
- Advanced Keycodes
- Software Features
  - Auto Shift
  - Combos
  - Debounce API
  - Key Lock
  - Key Overrides
  - Layers
  - One Shot Keys
  - Pointing Device
  - Raw HID
  - Sequencer
  - Swap Hands
  - Tap Dance
  - Tap-Hold Configuration
  - Terminal
  - Unicode
  - Userspace
  - WPM Calculation
- Hardware Features
  - Displays
  - Lighting
  - Audio
  - Bluetooth
  - Bootmagic Lite
  - Custom Matrix
  - Digitizer
  - DIP Switch
  - Encoders
  - Haptic Feedback
  - Joystick
  - LED Indicators
  - MIDI
  - Proton C Conversion
  - PS/2 Mouse
  - Split Keyboard
  - Stenography
  - Thermal Printer
  - Velocikey
- Keyboard Building
Developing QMK
- PR Checklist
- Breaking Changes
- C Development
- Python Development
  - Coding Conventions
  - QMK CLI Development
- Configurator Development
  - QMK API
    - Development Environment
    - Architecture Overview
- Hardware Platform Development
  - Arm/ChibiOS
    - Selecting an MCU
    - Early initialization
- QMK Reference
- For a Deeper Understanding
- QMK Internals (In Progress)