summaryrefslogtreecommitdiff
path: root/docs/_summary.md
blob: a429138b8fbe4b60f4f44a62b1222145a3d203b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
* [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)
  * [Best Git Practices](newbs_git_best_practices.md)
    * [Using Your Fork's Master](newbs_git_using_your_master_branch.md)
    * [Resolving Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
    * [Resynchronizing a Branch](newbs_git_resynchronize_a_branch.md)
  * [Learning Resources](newbs_learn_more_resources.md)

* [QMK Basics](README.md)
  * [QMK Introduction](getting_started_introduction.md)
  * [QMK CLI](cli.md)
  * [QMK CLI Config](cli_configuration.md)
  * [Contributing to QMK](contributing.md)
  * [How to Use Github](getting_started_github.md)
  * [Getting Help](getting_started_getting_help.md)

* [Breaking Changes](breaking_changes.md)
  * [My Pull Request Was Flagged](breaking_changes_instructions.md)
  * [2019 Aug 30](ChangeLog/20190830.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)
  * [Driver Installation with Zadig](driver_installation_zadig.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)
  * [Compatible Microcontrollers](compatible_microcontrollers.md)
  * [AVR Processors](hardware_avr.md)
  * [Drivers](hardware_drivers.md)

* Reference
  * [Keyboard Guidelines](hardware_keyboard_guidelines.md)
  * [Config Options](config_options.md)
  * [Keycodes](keycodes.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 CLI Development](cli_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)
  * [DIP Switch](feature_dip_switch.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
  * [Hand Wiring Guide](hand_wire.md)
  * [ISP Flashing Guide](isp_flashing_guide.md)
  * [ARM Debugging Guide](arm_debugging.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)
  * [Custom Matrix](custom_matrix.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](other_eclipse.md)
  * [Using VSCode with QMK](other_vscode.md)
  * [Support](support.md)
  * [Translating the QMK Docs](translating.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)