keychron_qmk_firmware/_summary.md at e02a3c559dfff16dd523e1b5ef65bf983f3638db - keychron_qmk_firmware - git.bdeshi.space

mirrors/keychron_qmk_firmware

mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-26 10:27:52 +06:00

skullydazed 8c97b4a3a4

Add a syllabus to guide people who are learning QMK (#8816 )

2020-04-19 09:08:38 +02:00

6.1 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
  - 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
- 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
- Breaking Changes
  - Overview
  - My Pull Request Was Flagged
  - History
    - 2020 Feb 29
    - 2019 Aug 30
- C Development
- Python Development
  - Coding Conventions
  - QMK CLI Development
- Configurator Development
  - QMK API
    - Development Environment
    - Architecture Overview
- Hardware Platform Development
  - Arm/ChibiOS
    - Early initialization
- QMK Reference
- For a Deeper Understanding
- QMK Internals (In Progress)