|
|
@ -1,36 +1,50 @@ |
|
|
|
* [Getting Started](README.md) |
|
|
|
* [QMK Introduction](getting_started_introduction.md) |
|
|
|
* [Install Build Tools](getting_started_build_tools.md) |
|
|
|
* Alternative: [Vagrant Guide](getting_started_vagrant.md) |
|
|
|
* [Build/Compile Instructions](getting_started_make_guide.md) |
|
|
|
* [Flashing Firmware](flashing.md) |
|
|
|
* [Contributing to QMK](contributing.md) |
|
|
|
* [How to Use Github](getting_started_github.md) |
|
|
|
* [Getting Help](getting_started_getting_help.md) |
|
|
|
|
|
|
|
* [Complete Newbs Guide](newbs.md) |
|
|
|
* [Getting Started](newbs_getting_started.md) |
|
|
|
* [Building Your First Firmware](newbs_building_firmware.md) |
|
|
|
* [Flashing Firmware](newbs_flashing.md) |
|
|
|
* [Testing and Debugging](newbs_testing_debugging.md) |
|
|
|
|
|
|
|
* [QMK Basics](README.md) |
|
|
|
* [QMK Introduction](getting_started_introduction.md) |
|
|
|
* [Contributing to QMK](contributing.md) |
|
|
|
* [How to Use Github](getting_started_github.md) |
|
|
|
* [Getting Help](getting_started_getting_help.md) |
|
|
|
|
|
|
|
* [FAQ](faq.md) |
|
|
|
* [General FAQ](faq_general.md) |
|
|
|
* [Build/Compile QMK](faq_build.md) |
|
|
|
* [Debugging/Troubleshooting QMK](faq_debug.md) |
|
|
|
* [Keymap](faq_keymap.md) |
|
|
|
|
|
|
|
* Detailed Guides |
|
|
|
* [Install Build Tools](getting_started_build_tools.md) |
|
|
|
* [Vagrant Guide](getting_started_vagrant.md) |
|
|
|
* [Build/Compile Instructions](getting_started_make_guide.md) |
|
|
|
* [Flashing Firmware](flashing.md) |
|
|
|
* [Customizing Functionality](custom_quantum_functions.md) |
|
|
|
* [Keymap Overview](keymap.md) |
|
|
|
|
|
|
|
* [Hardware](hardware.md) |
|
|
|
* [Keyboard Guidelines](hardware_keyboard_guidelines.md) |
|
|
|
* [AVR Processors](hardware_avr.md) |
|
|
|
* ARM Processors (TBD) |
|
|
|
* [Drivers](hardware_drivers.md) |
|
|
|
|
|
|
|
* Reference |
|
|
|
* [Keyboard Guidelines](hardware_keyboard_guidelines.md) |
|
|
|
* [Config Options](config_options.md) |
|
|
|
* [Keycodes](keycodes.md) |
|
|
|
* [Documentation Best Practices](documentation_best_practices.md) |
|
|
|
* [Documentation Templates](documentation_templates.md) |
|
|
|
* [Glossary](reference_glossary.md) |
|
|
|
* [Unit Testing](unit_testing.md) |
|
|
|
|
|
|
|
* [Features](features.md) |
|
|
|
* [Basic Keycodes](keycodes_basic.md) |
|
|
|
* [Quantum Keycodes](quantum_keycodes.md) |
|
|
|
* [Advanced Keycodes](feature_advanced_keycodes.md) |
|
|
|
* [Audio](feature_audio.md) |
|
|
|
* [Auto Shift](feature_auto_shift.md) |
|
|
|
* [Backlight](feature_backlight.md) |
|
|
|
* [Bluetooth](feature_bluetooth.md) |
|
|
|
* [Bootmagic](feature_bootmagic.md) |
|
|
|
* [Command](feature_command.md) |
|
|
|
* [Dynamic Macros](feature_dynamic_macros.md) |
|
|
@ -40,6 +54,7 @@ |
|
|
|
* [Leader Key](feature_leader_key.md) |
|
|
|
* [Macros](feature_macros.md) |
|
|
|
* [Mouse Keys](feature_mouse_keys.md) |
|
|
|
* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) |
|
|
|
* [Pointing Device](feature_pointing_device.md) |
|
|
|
* [PS/2 Mouse](feature_ps2_mouse.md) |
|
|
|
* [RGB Lighting](feature_rgblight.md) |
|
|
@ -53,34 +68,7 @@ |
|
|
|
* [Thermal Printer](feature_thermal_printer.md) |
|
|
|
* [Unicode](feature_unicode.md) |
|
|
|
* [Userspace](feature_userspace.md) |
|
|
|
|
|
|
|
* [Keycodes](keycodes.md) |
|
|
|
* [Basic](keycodes_basic.md) |
|
|
|
* [Quantum](quantum_keycodes.md) |
|
|
|
* [Audio](feature_audio.md#audio-keycodes) |
|
|
|
* [Backlight](feature_backlight.md#backlight-keycodes) |
|
|
|
* [Bluetooth](feature_bluetooth.md#bluetooth-keycodes) |
|
|
|
* [Bootmagic](feature_bootmagic.md#bootmagic-keycodes) |
|
|
|
* [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) |
|
|
|
* [Mod+Key](feature_advanced_keycodes.md#modifier-keys) |
|
|
|
* [Mod Tap](feature_advanced_keycodes.md#mod-tap) |
|
|
|
* [Mouse Keys](feature_mouse_keys.md#mapping-mouse-actions-to-keyboard-keys) |
|
|
|
* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys) |
|
|
|
* [RGB Light](feature_rgblight.md#rgblight-keycodes) |
|
|
|
* [RGB Matrix](feature_rgb_matrix.md#keycodes) |
|
|
|
* [Shifted Keys](keycodes_us_ansi_shifted.md) |
|
|
|
* [Stenography](feature_stenography.md#keycode-reference) |
|
|
|
* [Swap Hands](feature_swap_hands.md#swap-keycodes) |
|
|
|
* [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes) |
|
|
|
|
|
|
|
* Reference |
|
|
|
* [Config Options](config_options.md) |
|
|
|
* [Customizing Functionality](custom_quantum_functions.md) |
|
|
|
* [Documentation Best Practices](documentation_best_practices.md) |
|
|
|
* [Documentation Templates](documentation_templates.md) |
|
|
|
* [Glossary](reference_glossary.md) |
|
|
|
* [Keymap Overview](keymap.md) |
|
|
|
* [Unit Testing](unit_testing.md) |
|
|
|
* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) |
|
|
|
|
|
|
|
* For Makers and Modders |
|
|
|
* [Hand Wiring Guide](hand_wire.md) |
|
|
|