|
|
@ -1,125 +1,133 @@ |
|
|
|
* [Complete Newbs Guide](newbs.md) |
|
|
|
* [Introduction](newbs_getting_started.md) |
|
|
|
* Complete Newbs Guide |
|
|
|
* [Introduction](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) |
|
|
|
* [Getting Help](getting_started_getting_help.md) |
|
|
|
|
|
|
|
* Guides |
|
|
|
* [ARM Debugging Guide](arm_debugging.md) |
|
|
|
* [Best Git Practices](newbs_git_best_practices.md) |
|
|
|
* [Contributing to QMK](contributing.md) |
|
|
|
* [Customizing Functionality](custom_quantum_functions.md) |
|
|
|
* [Github Best Practices](getting_started_github.md) |
|
|
|
* [Hand Wiring Guide](hand_wire.md) |
|
|
|
* [ISP Flashing Guide](isp_flashing_guide.md) |
|
|
|
* [Flashing Firmware](flashing.md) |
|
|
|
* [Keymap Overview](keymap.md) |
|
|
|
* [Learning Resources](newbs_learn_more_resources.md) |
|
|
|
* [QMK CLI](cli.md) |
|
|
|
* [Vagrant Guide](getting_started_vagrant.md) |
|
|
|
|
|
|
|
* [Breaking Changes](breaking_changes.md) |
|
|
|
* Breaking Changes |
|
|
|
* [Overview](breaking_changes.md) |
|
|
|
* [My Pull Request Was Flagged](breaking_changes_instructions.md) |
|
|
|
* [2019 Aug 30](ChangeLog/20190830.md) |
|
|
|
* History |
|
|
|
* [2019 Aug 30](ChangeLog/20190830.md) |
|
|
|
|
|
|
|
* [FAQ](faq.md) |
|
|
|
* FAQs |
|
|
|
* [General FAQ](faq_general.md) |
|
|
|
* [Build/Compile QMK](faq_build.md) |
|
|
|
* [Debugging/Troubleshooting QMK](faq_debug.md) |
|
|
|
* [Keymap](faq_keymap.md) |
|
|
|
* [Driver Installation with Zadig](driver_installation_zadig.md) |
|
|
|
|
|
|
|
* QMK Features |
|
|
|
* [Keycodes](keycodes.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) |
|
|
|
* [Auto Shift](feature_auto_shift.md) |
|
|
|
* Software Features |
|
|
|
* [Combos](feature_combo.md) |
|
|
|
* [Command](feature_command.md) |
|
|
|
* [Debounce API](feature_debounce_type.md) |
|
|
|
* [Dynamic Macros](feature_dynamic_macros.md) |
|
|
|
* [Grave Escape](feature_grave_esc.md) |
|
|
|
* [Key Lock](feature_key_lock.md) |
|
|
|
* [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) |
|
|
|
* [Space Cadet](feature_space_cadet.md) |
|
|
|
* [Swap Hands](feature_swap_hands.md) |
|
|
|
* [Tap Dance](feature_tap_dance.md) |
|
|
|
* [Terminal](feature_terminal.md) |
|
|
|
* [Unicode](feature_unicode.md) |
|
|
|
* [Userspace](feature_userspace.md) |
|
|
|
* Hardware Features |
|
|
|
* [Audio](feature_audio.md) |
|
|
|
* [Backlight](feature_backlight.md) |
|
|
|
* [Bluetooth](feature_bluetooth.md) |
|
|
|
* [Bootmagic](feature_bootmagic.md) |
|
|
|
* [Custom Matrix](custom_matrix.md) |
|
|
|
* [DIP Switch](feature_dip_switch.md) |
|
|
|
* [Encoders](feature_encoders.md) |
|
|
|
* [Haptic Feedback](feature_haptic_feedback.md) |
|
|
|
* [HD44780 LCD Controller](feature_hd44780.md) |
|
|
|
* [LED Matrix](feature_led_matrix.md) |
|
|
|
* [OLED Driver](feature_oled_driver.md) |
|
|
|
* [Proton C Conversion](proton_c_conversion.md) |
|
|
|
* [PS/2 Mouse](feature_ps2_mouse.md) |
|
|
|
* [RGB Lighting](feature_rgblight.md) |
|
|
|
* [RGB Matrix](feature_rgb_matrix.md) |
|
|
|
* [Split Keyboard](feature_split_keyboard.md) |
|
|
|
* [Stenography](feature_stenography.md) |
|
|
|
* [Thermal Printer](feature_thermal_printer.md) |
|
|
|
* [Velocikey](feature_velocikey.md) |
|
|
|
* Using QMK |
|
|
|
* [Support](support.md) |
|
|
|
* Guides |
|
|
|
* [ARM Debugging Guide](arm_debugging.md) |
|
|
|
* [Best Git Practices](newbs_git_best_practices.md) |
|
|
|
* [Contributing to QMK](contributing.md) |
|
|
|
* [Customizing Functionality](custom_quantum_functions.md) |
|
|
|
* [Github Best Practices](getting_started_github.md) |
|
|
|
* [Hand Wiring Guide](hand_wire.md) |
|
|
|
* [ISP Flashing Guide](isp_flashing_guide.md) |
|
|
|
* [Flashing Firmware](flashing.md) |
|
|
|
* [Keymap Overview](keymap.md) |
|
|
|
* [Learning Resources](newbs_learn_more_resources.md) |
|
|
|
* [QMK CLI](cli.md) |
|
|
|
* [Vagrant Guide](getting_started_vagrant.md) |
|
|
|
|
|
|
|
* QMK Features |
|
|
|
* [Keycodes](keycodes.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) |
|
|
|
* [Auto Shift](feature_auto_shift.md) |
|
|
|
|
|
|
|
* QMK Reference |
|
|
|
* [Config Options](config_options.md) |
|
|
|
* [Make Documentation](getting_started_make_guide.md) |
|
|
|
* [Documentation Best Practices](documentation_best_practices.md) |
|
|
|
* [Documentation Templates](documentation_templates.md) |
|
|
|
* [Glossary](reference_glossary.md) |
|
|
|
* [Community Layouts](feature_layouts.md) |
|
|
|
* [Unit Testing](unit_testing.md) |
|
|
|
* [Useful Functions](ref_functions.md) |
|
|
|
* [Configurator Support](reference_configurator_support.md) |
|
|
|
* [info.json Format](reference_info_json.md) |
|
|
|
* Software Features |
|
|
|
* [Combos](feature_combo.md) |
|
|
|
* [Command](feature_command.md) |
|
|
|
* [Debounce API](feature_debounce_type.md) |
|
|
|
* [Dynamic Macros](feature_dynamic_macros.md) |
|
|
|
* [Grave Escape](feature_grave_esc.md) |
|
|
|
* [Key Lock](feature_key_lock.md) |
|
|
|
* [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) |
|
|
|
* [Space Cadet](feature_space_cadet.md) |
|
|
|
* [Swap Hands](feature_swap_hands.md) |
|
|
|
* [Tap Dance](feature_tap_dance.md) |
|
|
|
* [Terminal](feature_terminal.md) |
|
|
|
* [Unicode](feature_unicode.md) |
|
|
|
* [Userspace](feature_userspace.md) |
|
|
|
|
|
|
|
* C Development |
|
|
|
* [AVR Processors](hardware_avr.md) |
|
|
|
* [Coding Conventions](coding_conventions_c.md) |
|
|
|
* [Compatible Microcontrollers](compatible_microcontrollers.md) |
|
|
|
* [Drivers](hardware_drivers.md) |
|
|
|
* [ADC Driver](adc_driver.md) |
|
|
|
* [I2C Driver](i2c_driver.md) |
|
|
|
* [WS2812 Driver](ws2812_driver.md) |
|
|
|
* [EEPROM Driver](eeprom_driver.md) |
|
|
|
* [GPIO Controls](internals_gpio_control.md) |
|
|
|
* [Keyboard Guidelines](hardware_keyboard_guidelines.md) |
|
|
|
* Hardware Features |
|
|
|
* [Audio](feature_audio.md) |
|
|
|
* [Backlight](feature_backlight.md) |
|
|
|
* [Bluetooth](feature_bluetooth.md) |
|
|
|
* [Bootmagic](feature_bootmagic.md) |
|
|
|
* [Custom Matrix](custom_matrix.md) |
|
|
|
* [DIP Switch](feature_dip_switch.md) |
|
|
|
* [Encoders](feature_encoders.md) |
|
|
|
* [Haptic Feedback](feature_haptic_feedback.md) |
|
|
|
* [HD44780 LCD Controller](feature_hd44780.md) |
|
|
|
* [LED Matrix](feature_led_matrix.md) |
|
|
|
* [OLED Driver](feature_oled_driver.md) |
|
|
|
* [Proton C Conversion](proton_c_conversion.md) |
|
|
|
* [PS/2 Mouse](feature_ps2_mouse.md) |
|
|
|
* [RGB Lighting](feature_rgblight.md) |
|
|
|
* [RGB Matrix](feature_rgb_matrix.md) |
|
|
|
* [Split Keyboard](feature_split_keyboard.md) |
|
|
|
* [Stenography](feature_stenography.md) |
|
|
|
* [Thermal Printer](feature_thermal_printer.md) |
|
|
|
* [Velocikey](feature_velocikey.md) |
|
|
|
|
|
|
|
* Python Development |
|
|
|
* [Coding Conventions](coding_conventions_python.md) |
|
|
|
* [QMK CLI Config](cli_configuration.md) |
|
|
|
* [Python CLI Development](cli_development.md) |
|
|
|
* Other Topics |
|
|
|
* [Using Eclipse with QMK](other_eclipse.md) |
|
|
|
* [Using VSCode with QMK](other_vscode.md) |
|
|
|
|
|
|
|
* For a Deeper Understanding |
|
|
|
* [How Keyboards Work](how_keyboards_work.md) |
|
|
|
* [Understanding QMK](understanding_qmk.md) |
|
|
|
|
|
|
|
* Other Topics |
|
|
|
* [Using Eclipse with QMK](other_eclipse.md) |
|
|
|
* [Using VSCode with QMK](other_vscode.md) |
|
|
|
* [Support](support.md) |
|
|
|
* [Translating the QMK Docs](translating.md) |
|
|
|
* Developing QMK |
|
|
|
* QMK Reference |
|
|
|
* [Translating the QMK Docs](translating.md) |
|
|
|
* [Config Options](config_options.md) |
|
|
|
* [Make Documentation](getting_started_make_guide.md) |
|
|
|
* [Documentation Best Practices](documentation_best_practices.md) |
|
|
|
* [Documentation Templates](documentation_templates.md) |
|
|
|
* [Glossary](reference_glossary.md) |
|
|
|
* [Community Layouts](feature_layouts.md) |
|
|
|
* [Unit Testing](unit_testing.md) |
|
|
|
* [Useful Functions](ref_functions.md) |
|
|
|
* [Configurator Support](reference_configurator_support.md) |
|
|
|
* [info.json Format](reference_info_json.md) |
|
|
|
|
|
|
|
* C Development |
|
|
|
* [AVR Processors](hardware_avr.md) |
|
|
|
* [Coding Conventions](coding_conventions_c.md) |
|
|
|
* [Compatible Microcontrollers](compatible_microcontrollers.md) |
|
|
|
* [Drivers](hardware_drivers.md) |
|
|
|
* [ADC Driver](adc_driver.md) |
|
|
|
* [I2C Driver](i2c_driver.md) |
|
|
|
* [WS2812 Driver](ws2812_driver.md) |
|
|
|
* [EEPROM Driver](eeprom_driver.md) |
|
|
|
* [GPIO Controls](internals_gpio_control.md) |
|
|
|
* [Keyboard Guidelines](hardware_keyboard_guidelines.md) |
|
|
|
|
|
|
|
* Python Development |
|
|
|
* [Coding Conventions](coding_conventions_python.md) |
|
|
|
* [QMK CLI Config](cli_configuration.md) |
|
|
|
* [Python CLI Development](cli_development.md) |
|
|
|
|
|
|
|
* For a Deeper Understanding |
|
|
|
* [How Keyboards Work](how_keyboards_work.md) |
|
|
|
* [Understanding QMK](understanding_qmk.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) |
|
|
|
* 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) |