-* [Getting started](README.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)
+ * [Git Best Practices](newbs_best_practices.md)
+ * [Learning Resources](newbs_learn_more_resources.md)
+
+* [QMK Basics](README.md)
* [QMK Introduction](getting_started_introduction.md)
- * [Install Build Tools](getting_started_build_tools.md)
- * Alternative: [Vagrant Guide](getting_started_vagrant_guide.md)
- * [Build/Compile instructions](getting_started_make_guide.md)
+ * [QMK CLI](cli.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)
* [Debugging/Troubleshooting QMK](faq_debug.md)
* [Keymap](faq_keymap.md)
-* [Features](features.md)
- * [Common Shortcuts](feature_common_shortcuts.md)
- * [Backlight](feature_backlight.md)
- * [Bootmagic](feature_bootmagic.md)
- * [Dynamic Macros](dynamic_macros.md)
- * [Key Lock](key_lock.md)
- * [Leader Key](feature_leader_key.md)
- * [Macros](macros.md)
- * [Mouse keys](mouse_keys.md)
- * [PS2 Mouse](feature_ps2_mouse.md)
- * [Space Cadet](space_cadet_shift.md)
- * [Tap Dance](tap_dance.md)
- * [Thermal Printer](feature_thermal_printer.md)
- * [Stenography](stenography.md)
- * [Unicode](unicode.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)
+ * [AVR Processors](hardware_avr.md)
+ * [Drivers](hardware_drivers.md)
* Reference
- * [Glossary](glossary.md)
- * [Keymap overview](keymap.md)
+ * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
+ * [Config Options](config_options.md)
* [Keycodes](keycodes.md)
- * [Basic](keycodes_basic.md)
- * [Quantum](quantum_keycodes.md)
- * [Backlight](feature_backlight.md#backlight-keycodes)
- * [Bluetooth](feature_bluetooth.md#bluetooth-keycodes)
- * [Bootmagic](feature_bootmagic.md#bootmagic-keycodes)
- * [Layer Switching](feature_common_shortcuts.md#switching-and-toggling-layers)
- * [Mod+Key](feature_common_shortcuts.md#modifier-keys)
- * [Mod Tap](feature_common_shortcuts.md#mod-tap)
- * [One Shot Keys](feature_common_shortcuts.md#one-shot-keys)
- * [Shifted Keys](feature_common_shortcuts.md#shifted-keycodes)
- * [Stenography](stenography.md#keycode-reference)
- * [RGB Light](feature_rgblight.md#rgblight-keycodes)
- * [Thermal Printer](feature_thermal_printer.md#thermal-printer-keycodes)
- * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
- * [The `config.h` File](config_options.md)
- * [Customizing Functionality](custom_quantum_functions.md)
+ * [Coding Conventions - C](coding_conventions_c.md)
+ * [Coding Conventions - Python](coding_conventions_python.md)
* [Documentation Best Practices](documentation_best_practices.md)
+ * [Documentation Templates](documentation_templates.md)
+ * [Glossary](reference_glossary.md)
* [Unit Testing](unit_testing.md)
+ * [Useful Functions](ref_functions.md)
+ * [Configurator Support](reference_configurator_support.md)
+ * [info.json Format](reference_info_json.md)
+ * [Python Development](python_development.md)
+
+* [Features](features.md)
+ * [Basic Keycodes](keycodes_basic.md)
+ * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.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)
+ * [Combos](feature_combo.md)
+ * [Command](feature_command.md)
+ * [Debounce API](feature_debounce_type.md)
+ * [Dynamic Macros](feature_dynamic_macros.md)
+ * [Encoders](feature_encoders.md)
+ * [Grave Escape](feature_grave_esc.md)
+ * [Haptic Feedback](feature_haptic_feedback.md)
+ * [HD44780 LCD Controller](feature_hd44780.md)
+ * [Key Lock](feature_key_lock.md)
+ * [Layouts](feature_layouts.md)
+ * [Leader Key](feature_leader_key.md)
+ * [LED Matrix](feature_led_matrix.md)
+ * [Macros](feature_macros.md)
+ * [Mouse Keys](feature_mouse_keys.md)
+ * [OLED Driver](feature_oled_driver.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)
+ * [RGB Matrix](feature_rgb_matrix.md)
+ * [Space Cadet](feature_space_cadet.md)
+ * [Split Keyboard](feature_split_keyboard.md)
+ * [Stenography](feature_stenography.md)
+ * [Swap Hands](feature_swap_hands.md)
+ * [Tap Dance](feature_tap_dance.md)
+ * [Terminal](feature_terminal.md)
+ * [Thermal Printer](feature_thermal_printer.md)
+ * [Unicode](feature_unicode.md)
+ * [Userspace](feature_userspace.md)
+ * [Velocikey](feature_velocikey.md)
* For Makers and Modders
- * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
- * [Adding features to QMK](adding_features_to_qmk.md)
- * [Hand Wiring Guide](hand_wiring.md)
- * [ISP flashing guide](isp_flashing_guide.md)
- * [Modding your keyboard](modding_your_keyboard.md)
- * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
+ * [Hand Wiring Guide](hand_wire.md)
+ * [ISP Flashing Guide](isp_flashing_guide.md)
+ * [ARM Debugging Guide](arm_debugging.md)
+ * [I2C Driver](i2c_driver.md)
+ * [GPIO Controls](internals_gpio_control.md)
+ * [Proton C Conversion](proton_c_conversion.md)
* For a Deeper Understanding
* [How Keyboards Work](how_keyboards_work.md)
* [Understanding QMK](understanding_qmk.md)
* Other Topics
- * [Using Eclipse with QMK](eclipse.md)
+ * [Using Eclipse with QMK](other_eclipse.md)
+ * [Using VSCode with QMK](other_vscode.md)
+ * [Support](support.md)
+
+* QMK Internals (In Progress)
+ * [Defines](internals_defines.md)
+ * [Input Callback Reg](internals_input_callback_reg.md)
+ * [Midi Device](internals_midi_device.md)
+ * [Midi Device Setup Process](internals_midi_device_setup_process.md)
+ * [Midi Util](internals_midi_util.md)
+ * [Send Functions](internals_send_functions.md)
+ * [Sysex Tools](internals_sysex_tools.md)
projects / qmk_firmware.git / blobdiff