qmk_firmware/_sidebar.md at 435a1202e7575dba61bb9a48070ddc90ccda2993 - qmk_firmware - Gitea: Git with a cup of tea

guru/qmk_firmware

fauxpark 03ad6927cb Docs: Format Space Cadet documentation (#3540 )

* Format Space Cadet documentation

* Fix page filenames

* Move Caveats section up

2018-08-01 08:43:54 -07:00

4.1 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
- RGB Matrix
- Space Cadet Shift
- Space Cadet Shift Enter
- Stenography
- Swap Hands
- Tap Dance
- Terminal
- Thermal Printer
- Unicode
- Userspace
Keycodes
- Basic
- Quantum
- Audio
- Backlight
- Bluetooth
- Bootmagic
- Layer Switching
- Mod+Key
- Mod Tap
- Mouse Keys
- One Shot Keys
- RGB Light
- RGB Matrix
- Shifted Keys
- Stenography
- Swap Hands
- Thermal Printer
- US ANSI Shifted Keys
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 Internals (In Progress)