qmk-firmware/_summary.md at 67cc5cebc0430d15169e2c649ea25112a31bfa31 - qmk-firmware - sporq's Gitea

sporq/qmk-firmware

skullydazed 67cc5cebc0 Restructure the hardware and feature docs to make things easier to find (#1888 )

* fix #1313 by documenting more config.h options

* Clean up and organize documentation

2017-10-24 20:34:28 -07:00

3.0 KiB

Raw Blame History

Getting started
- QMK Introduction
- Install Build Tools
  - Alternative: Vagrant Guide
- Build/Compile instructions
- Contributing to QMK
- How to Use Github
FAQ
Hardware
- Keyboard Guidelines
- AVR Processors
- ARM Processors (TBD)
- Drivers
Features
- Advanced Keycodes
- Audio
- Backlight
- Bootmagic
- Dynamic Macros
- Key Lock
- Layouts
- Leader Key
- Macros
- Mouse keys
- Pointing Device
- PS2 Mouse
- Space Cadet
- Stenography
- Tap Dance
- Terminal
- Thermal Printer
- Unicode
- Userspace
Reference
For Makers and Modders
For a Deeper Understanding
- How Keyboards Work
- Understanding QMK
Other Topics
- Using Eclipse with QMK