qmk-firmware/docs/_summary.md at 2bdd73f80135965c1047b24b78fdf15c1ebbbee7 - fern/qmk-firmware - Fern's Git Server

fern/qmk-firmware

mirror of https://github.com/firewalkwithm3/qmk_firmware.git synced 2024-11-23 03:50:28 +08:00

Drashna Jael're 3d98269652

Merge remote-tracking branch 'origin/master' into develop

2022-07-27 07:40:30 -07:00

7.5 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
  - Caps Word
  - Combos
  - Debounce API
  - Key Lock
  - Key Overrides
  - Layers
  - One Shot Keys
  - Raw HID
  - Secure
  - Send String
  - Sequencer
  - Swap Hands
  - Tap Dance
  - Tap-Hold Configuration
  - Unicode
  - Userspace
  - WPM Calculation
- Hardware Features
  - Displays
    - Quantum Painter
    - HD44780 LCD Driver
    - ST7565 LCD Driver
    - OLED Driver
  - Lighting
    - Backlight
    - LED Matrix
    - RGB Lighting
    - RGB Matrix
  - Audio
  - Bluetooth
  - Bootmagic Lite
  - Converters
  - Custom Matrix
  - Digitizer
  - DIP Switch
  - Encoders
  - Haptic Feedback
  - Joystick
  - LED Indicators
  - MIDI
  - Pointing Device
  - 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
- QMK Reference
- For a Deeper Understanding
- QMK Internals (In Progress)