|
@@ -1,17 +1,20 @@
|
|
|
* Complete Newbs Guide
|
|
|
* [Introduction](newbs.md)
|
|
|
- * [Getting Started](newbs_getting_started.md)
|
|
|
+ * [Setup](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)
|
|
|
+ * Other Topics
|
|
|
+ * [Learning Resources](newbs_learn_more_resources.md)
|
|
|
+ * [Using Eclipse with QMK](other_eclipse.md)
|
|
|
+ * [Using VSCode with QMK](other_vscode.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)
|
|
|
|
|
|
* Configurator
|
|
|
* [Overview](newbs_building_firmware_configurator.md)
|
|
@@ -20,74 +23,80 @@
|
|
|
* [Overview](api_overview.md)
|
|
|
* [API Documentation](api_docs.md)
|
|
|
|
|
|
+* CLI
|
|
|
+ * [Overview](cli.md)
|
|
|
+ * [Configuration](cli_configuration.md)
|
|
|
+ * [Commands](cli_commands.md)
|
|
|
+
|
|
|
* Using QMK
|
|
|
* 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)
|
|
|
- * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md)
|
|
|
- * [Flashing Firmware](flashing.md)
|
|
|
- * [Github Best Practices](getting_started_github.md)
|
|
|
- * [Hand Wiring Guide](hand_wire.md)
|
|
|
- * [ISP Flashing Guide](isp_flashing_guide.md)
|
|
|
+ * [Driver Installation with Zadig](driver_installation_zadig.md)
|
|
|
* [Keymap Overview](keymap.md)
|
|
|
- * [Learning Resources](newbs_learn_more_resources.md)
|
|
|
- * [QMK CLI](cli.md)
|
|
|
* [Vagrant Guide](getting_started_vagrant.md)
|
|
|
+ * Flashing
|
|
|
+ * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md)
|
|
|
+ * [Flashing Firmware](flashing.md)
|
|
|
+ * Git Best Practices
|
|
|
+ * [Introduction](newbs_git_best_practices.md)
|
|
|
+ * [Your Fork](newbs_git_using_your_master_branch.md)
|
|
|
+ * [Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
|
|
|
+ * [Fixing Your Branch](newbs_git_resynchronize_a_branch.md)
|
|
|
+ * Keyboard Building
|
|
|
+ * [Hand Wiring Guide](hand_wire.md)
|
|
|
+ * [ISP Flashing Guide](isp_flashing_guide.md)
|
|
|
|
|
|
- * QMK Features
|
|
|
- * Keycodes
|
|
|
- * [Full List](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)
|
|
|
+ * Simple Keycodes
|
|
|
+ * [Full List](keycodes.md)
|
|
|
+ * [Basic Keycodes](keycodes_basic.md)
|
|
|
+ * [Advanced Keycodes](feature_advanced_keycodes.md)
|
|
|
+ * [Quantum Keycodes](quantum_keycodes.md)
|
|
|
|
|
|
- * Software Features
|
|
|
- * [Auto Shift](feature_auto_shift.md)
|
|
|
- * [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)
|
|
|
+ * Advanced Keycodes
|
|
|
+ * [Auto Shift](feature_auto_shift.md)
|
|
|
+ * [Command](feature_command.md)
|
|
|
+ * [Dynamic Macros](feature_dynamic_macros.md)
|
|
|
+ * [Grave Escape](feature_grave_esc.md)
|
|
|
+ * [Leader Key](feature_leader_key.md)
|
|
|
+ * [Macros](feature_macros.md)
|
|
|
+ * [Mouse Keys](feature_mouse_keys.md)
|
|
|
+ * [Space Cadet Shift](feature_space_cadet.md)
|
|
|
+ * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.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)
|
|
|
+ * Software Features
|
|
|
+ * [Combos](feature_combo.md)
|
|
|
+ * [Debounce API](feature_debounce_type.md)
|
|
|
+ * [Key Lock](feature_key_lock.md)
|
|
|
+ * [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
|
|
|
+ * [Pointing Device](feature_pointing_device.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
|
|
|
+ * Displays
|
|
|
* [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)
|
|
|
+ * Lighting
|
|
|
+ * [Backlight](feature_backlight.md)
|
|
|
+ * [LED Matrix](feature_led_matrix.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)
|
|
|
-
|
|
|
- * Other Topics
|
|
|
- * [Using Eclipse with QMK](other_eclipse.md)
|
|
|
- * [Using VSCode with QMK](other_vscode.md)
|
|
|
+ * [Audio](feature_audio.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)
|
|
|
+ * [Proton C Conversion](proton_c_conversion.md)
|
|
|
+ * [PS/2 Mouse](feature_ps2_mouse.md)
|
|
|
+ * [Split Keyboard](feature_split_keyboard.md)
|
|
|
+ * [Stenography](feature_stenography.md)
|
|
|
+ * [Thermal Printer](feature_thermal_printer.md)
|
|
|
+ * [Velocikey](feature_velocikey.md)
|
|
|
|
|
|
* Developing QMK
|
|
|
* Breaking Changes
|
|
@@ -96,19 +105,8 @@
|
|
|
* History
|
|
|
* [2019 Aug 30](ChangeLog/20190830.md)
|
|
|
|
|
|
- * 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)
|
|
|
- * [info.json Format](reference_info_json.md)
|
|
|
-
|
|
|
* C Development
|
|
|
+ * [ARM Debugging Guide](arm_debugging.md)
|
|
|
* [AVR Processors](hardware_avr.md)
|
|
|
* [Coding Conventions](coding_conventions_c.md)
|
|
|
* [Compatible Microcontrollers](compatible_microcontrollers.md)
|
|
@@ -122,14 +120,27 @@
|
|
|
|
|
|
* Python Development
|
|
|
* [Coding Conventions](coding_conventions_python.md)
|
|
|
- * [QMK CLI Config](cli_configuration.md)
|
|
|
- * [Python CLI Development](cli_development.md)
|
|
|
+ * [QMK CLI Development](cli_development.md)
|
|
|
+ * [QMK CLI Config](cli_dev_configuration.md)
|
|
|
|
|
|
* Configurator Development
|
|
|
* QMK API
|
|
|
* [Development Environment](api_development_environment.md)
|
|
|
* [Architecture Overview](api_development_overview.md)
|
|
|
|
|
|
+ * QMK Reference
|
|
|
+ * [Contributing to QMK](contributing.md)
|
|
|
+ * [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)
|
|
|
+ * [info.json Format](reference_info_json.md)
|
|
|
+
|
|
|
* For a Deeper Understanding
|
|
|
* [How Keyboards Work](how_keyboards_work.md)
|
|
|
* [Understanding QMK](understanding_qmk.md)
|