45e218ce |
1 | * Tutorial |
5b144560 |
2 | * [Introduction](newbs.md) |
86f64055 |
3 | * [Setup](newbs_getting_started.md) |
08e48eb6 |
4 | * [Building Your First Firmware](newbs_building_firmware.md) |
5 | * [Flashing Firmware](newbs_flashing.md) |
6 | * [Testing and Debugging](newbs_testing_debugging.md) |
d1c18086 |
7 | * [Getting Help](getting_started_getting_help.md) |
8b0fdc82 |
8 | * [Other Resources](newbs_learn_more_resources.md) |
d1c18086 |
9 | |
5b144560 |
10 | * FAQs |
e6c638be |
11 | * [General FAQ](faq_general.md) |
12 | * [Build/Compile QMK](faq_build.md) |
13 | * [Debugging/Troubleshooting QMK](faq_debug.md) |
5d35098b |
14 | * [Keymap FAQ](faq_keymap.md) |
15 | * [Glossary](reference_glossary.md) |
995c3141 |
16 | |
99850aab |
17 | * Configurator |
18 | * [Overview](newbs_building_firmware_configurator.md) |
45e218ce |
19 | * [Step by Step](configurator_step_by_step.md) |
20 | * [Troubleshooting](configurator_troubleshooting.md) |
21 | * [Problems and Bugs](configurator_problems.md) |
99850aab |
22 | * QMK API |
23 | * [Overview](api_overview.md) |
24 | * [API Documentation](api_docs.md) |
45e218ce |
25 | * [Keyboard Support](reference_configurator_support.md) |
99850aab |
26 | |
86f64055 |
27 | * CLI |
28 | * [Overview](cli.md) |
29 | * [Configuration](cli_configuration.md) |
30 | * [Commands](cli_commands.md) |
31 | |
5b144560 |
32 | * Using QMK |
5b144560 |
33 | * Guides |
5b144560 |
34 | * [Customizing Functionality](custom_quantum_functions.md) |
86f64055 |
35 | * [Driver Installation with Zadig](driver_installation_zadig.md) |
5b144560 |
36 | * [Keymap Overview](keymap.md) |
5b144560 |
37 | * [Vagrant Guide](getting_started_vagrant.md) |
86f64055 |
38 | * Flashing |
45e218ce |
39 | * [Flashing](flashing.md) |
86f64055 |
40 | * [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md) |
8b0fdc82 |
41 | * IDEs |
42 | * [Using Eclipse with QMK](other_eclipse.md) |
43 | * [Using VSCode with QMK](other_vscode.md) |
86f64055 |
44 | * Git Best Practices |
45 | * [Introduction](newbs_git_best_practices.md) |
46 | * [Your Fork](newbs_git_using_your_master_branch.md) |
47 | * [Merge Conflicts](newbs_git_resolving_merge_conflicts.md) |
48 | * [Fixing Your Branch](newbs_git_resynchronize_a_branch.md) |
49 | * Keyboard Building |
50 | * [Hand Wiring Guide](hand_wire.md) |
51 | * [ISP Flashing Guide](isp_flashing_guide.md) |
5b144560 |
52 | |
86f64055 |
53 | * Simple Keycodes |
54 | * [Full List](keycodes.md) |
55 | * [Basic Keycodes](keycodes_basic.md) |
9035c349 |
56 | * [Layer Switching](feature_advanced_keycodes.md) |
86f64055 |
57 | * [Quantum Keycodes](quantum_keycodes.md) |
67cc5ceb |
58 | |
86f64055 |
59 | * Advanced Keycodes |
86f64055 |
60 | * [Command](feature_command.md) |
61 | * [Dynamic Macros](feature_dynamic_macros.md) |
62 | * [Grave Escape](feature_grave_esc.md) |
63 | * [Leader Key](feature_leader_key.md) |
9035c349 |
64 | * [Mod-Tap](mod_tap.md) |
86f64055 |
65 | * [Macros](feature_macros.md) |
66 | * [Mouse Keys](feature_mouse_keys.md) |
67 | * [Space Cadet Shift](feature_space_cadet.md) |
68 | * [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) |
da24a34e |
69 | |
86f64055 |
70 | * Software Features |
45e218ce |
71 | * [Auto Shift](feature_auto_shift.md) |
86f64055 |
72 | * [Combos](feature_combo.md) |
73 | * [Debounce API](feature_debounce_type.md) |
74 | * [Key Lock](feature_key_lock.md) |
9035c349 |
75 | * [One Shot Keys](one_shot_keys.md) |
86f64055 |
76 | * [Pointing Device](feature_pointing_device.md) |
77 | * [Swap Hands](feature_swap_hands.md) |
78 | * [Tap Dance](feature_tap_dance.md) |
9035c349 |
79 | * [Tap-Hold Configuration](tap_hold.md) |
86f64055 |
80 | * [Terminal](feature_terminal.md) |
81 | * [Unicode](feature_unicode.md) |
82 | * [Userspace](feature_userspace.md) |
83 | |
84 | * Hardware Features |
85 | * Displays |
5b144560 |
86 | * [HD44780 LCD Controller](feature_hd44780.md) |
5b144560 |
87 | * [OLED Driver](feature_oled_driver.md) |
86f64055 |
88 | * Lighting |
89 | * [Backlight](feature_backlight.md) |
90 | * [LED Matrix](feature_led_matrix.md) |
5b144560 |
91 | * [RGB Lighting](feature_rgblight.md) |
92 | * [RGB Matrix](feature_rgb_matrix.md) |
86f64055 |
93 | * [Audio](feature_audio.md) |
94 | * [Bluetooth](feature_bluetooth.md) |
95 | * [Bootmagic](feature_bootmagic.md) |
96 | * [Custom Matrix](custom_matrix.md) |
97 | * [DIP Switch](feature_dip_switch.md) |
98 | * [Encoders](feature_encoders.md) |
99 | * [Haptic Feedback](feature_haptic_feedback.md) |
100 | * [Proton C Conversion](proton_c_conversion.md) |
101 | * [PS/2 Mouse](feature_ps2_mouse.md) |
102 | * [Split Keyboard](feature_split_keyboard.md) |
103 | * [Stenography](feature_stenography.md) |
104 | * [Thermal Printer](feature_thermal_printer.md) |
105 | * [Velocikey](feature_velocikey.md) |
c12f1910 |
106 | |
5b144560 |
107 | * Developing QMK |
99850aab |
108 | * Breaking Changes |
109 | * [Overview](breaking_changes.md) |
110 | * [My Pull Request Was Flagged](breaking_changes_instructions.md) |
111 | * History |
112 | * [2019 Aug 30](ChangeLog/20190830.md) |
113 | |
5b144560 |
114 | * C Development |
86f64055 |
115 | * [ARM Debugging Guide](arm_debugging.md) |
5b144560 |
116 | * [AVR Processors](hardware_avr.md) |
117 | * [Coding Conventions](coding_conventions_c.md) |
118 | * [Compatible Microcontrollers](compatible_microcontrollers.md) |
119 | * [Drivers](hardware_drivers.md) |
120 | * [ADC Driver](adc_driver.md) |
121 | * [I2C Driver](i2c_driver.md) |
122 | * [WS2812 Driver](ws2812_driver.md) |
123 | * [EEPROM Driver](eeprom_driver.md) |
124 | * [GPIO Controls](internals_gpio_control.md) |
125 | * [Keyboard Guidelines](hardware_keyboard_guidelines.md) |
126 | |
127 | * Python Development |
128 | * [Coding Conventions](coding_conventions_python.md) |
86f64055 |
129 | * [QMK CLI Development](cli_development.md) |
130 | * [QMK CLI Config](cli_dev_configuration.md) |
5b144560 |
131 | |
99850aab |
132 | * Configurator Development |
133 | * QMK API |
134 | * [Development Environment](api_development_environment.md) |
135 | * [Architecture Overview](api_development_overview.md) |
136 | |
86f64055 |
137 | * QMK Reference |
138 | * [Contributing to QMK](contributing.md) |
139 | * [Translating the QMK Docs](translating.md) |
140 | * [Config Options](config_options.md) |
141 | * [Make Documentation](getting_started_make_guide.md) |
142 | * [Documentation Best Practices](documentation_best_practices.md) |
143 | * [Documentation Templates](documentation_templates.md) |
86f64055 |
144 | * [Community Layouts](feature_layouts.md) |
145 | * [Unit Testing](unit_testing.md) |
146 | * [Useful Functions](ref_functions.md) |
147 | * [info.json Format](reference_info_json.md) |
148 | |
5b144560 |
149 | * For a Deeper Understanding |
150 | * [How Keyboards Work](how_keyboards_work.md) |
151 | * [Understanding QMK](understanding_qmk.md) |
7c9d5ace |
152 | |
5b144560 |
153 | * QMK Internals (In Progress) |
154 | * [Defines](internals_defines.md) |
155 | * [Input Callback Reg](internals_input_callback_reg.md) |
156 | * [Midi Device](internals_midi_device.md) |
157 | * [Midi Device Setup Process](internals_midi_device_setup_process.md) |
158 | * [Midi Util](internals_midi_util.md) |
159 | * [Send Functions](internals_send_functions.md) |
160 | * [Sysex Tools](internals_sysex_tools.md) |