qmk_firmware/docs/_summary.md at 0f0530c5a4441eecd5941f1f61f74ea89d15e9a2

* Add PR checklist document.

* Update docs/pr_checklist.md

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

* Reword the lower/raise/adjust suggestion somewhat for clarity.

* Add suggestion from @Didel for coding conventions.

Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Ryan <fauxpark@gmail.com>

2020-08-07 06:16:14 +10:00

6.5 KiB

Raw Blame History

Tutorial
FAQs
Configurator
- Overview
- Step by Step
- Troubleshooting
- 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
  - Keyboard Building
    - Hand Wiring Guide
    - ISP Flashing Guide
- Simple Keycodes
- Advanced Keycodes
- Software Features
  - Auto Shift
  - Combos
  - Debounce API
  - Key Lock
  - Layers
  - One Shot Keys
  - Pointing Device
  - Raw HID
  - Swap Hands
  - Tap Dance
  - Tap-Hold Configuration
  - Terminal
  - Unicode
  - Userspace
  - WPM Calculation
- Hardware Features
  - Displays
    - HD44780 LCD Controller
    - OLED Driver
  - Lighting
  - Audio
  - Bluetooth
  - Bootmagic
  - Custom Matrix
  - DIP Switch
  - Encoders
  - Haptic Feedback
  - Proton C Conversion
  - PS/2 Mouse
  - Split Keyboard
  - Stenography
  - Thermal Printer
  - Velocikey
Developing QMK
- PR Checklist
- Breaking Changes
  - Overview
  - My Pull Request Was Flagged
  - History
- 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)

6.5 KiB Raw Blame History

6.5 KiB

Raw Blame History