qmk_firmware/docs/_summary.md at 3ee59a79aaa333c82e088a2e359a16fa37a2352f

skullydazed 7c9d5ace14 Generate API docs from source code comments (#2491 )

* Generate api docs from source code

* Add a bunch of doxygen comments

* more doxygen comments

* Add the in-progress api docs

* script to generate docs from travis

* Add doc generation to the travis job

* make travis_docs.sh commit the work it does

* make sure the docs script exits cleanly

2018-03-22 02:50:38 -04:00

3.7 KiB

Raw Blame History

Getting Started
- QMK Introduction
- Install Build Tools
  - Alternative: Vagrant Guide
- Build/Compile Instructions
- Flashing Firmware
- Contributing to QMK
- How to Use Github
- Getting Help
Complete Newbs Guide
FAQ
Hardware
- Keyboard Guidelines
- AVR Processors
- ARM Processors (TBD)
- Drivers
Features
- Advanced Keycodes
- Audio
- Auto Shift
- Backlight
- Bootmagic
- Command
- Dynamic Macros
- Grave Escape
- Key Lock
- Layouts
- Leader Key
- Macros
- Mouse Keys
- Pointing Device
- PS/2 Mouse
- RGB Lighting
- Space Cadet
- Stenography
- Swap Hands
- Tap Dance
- Terminal
- Thermal Printer
- Unicode
- Userspace
Keycodes
Reference
For Makers and Modders
- Hand Wiring Guide
- ISP Flashing Guide
For a Deeper Understanding
- How Keyboards Work
- Understanding QMK
Other Topics
- Using Eclipse with QMK
QMK API (In Progress)

3.7 KiB Raw Blame History

3.7 KiB

Raw Blame History