[jackhill/qmk/firmware.git] / docs / _summary.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)
  * [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)
  * [Build/Compile QMK](faq_build.md)
  * [Debugging/Troubleshooting QMK](faq_debug.md)
  * [Keymap](faq_keymap.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
  * [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 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
  * [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](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)
Commit	Line	Data
08e48eb6	1	* [Complete Newbs Guide](newbs.md)
	2	* [Getting Started](newbs_getting_started.md)
	3	* [Building Your First Firmware](newbs_building_firmware.md)
	4	* [Flashing Firmware](newbs_flashing.md)
	5	* [Testing and Debugging](newbs_testing_debugging.md)
c534a4c7	6	* [Git Best Practices](newbs_best_practices.md)
480651cf	7	* [Learning Resources](newbs_learn_more_resources.md)
e6c638be	8
da24a34e	9	* [QMK Basics](README.md)
da24a34e	10	* [QMK Introduction](getting_started_introduction.md)
a25dd58b	11	* [QMK CLI](cli.md)
da24a34e	12	* [Contributing to QMK](contributing.md)
	13	* [How to Use Github](getting_started_github.md)
	14	* [Getting Help](getting_started_getting_help.md)
	15
e6c638be	16	* [FAQ](faq.md)
	17	* [General FAQ](faq_general.md)
	18	* [Build/Compile QMK](faq_build.md)
	19	* [Debugging/Troubleshooting QMK](faq_debug.md)
	20	* [Keymap](faq_keymap.md)
995c3141	21
da24a34e	22	* Detailed Guides
	23	* [Install Build Tools](getting_started_build_tools.md)
	24	* [Vagrant Guide](getting_started_vagrant.md)
	25	* [Build/Compile Instructions](getting_started_make_guide.md)
	26	* [Flashing Firmware](flashing.md)
	27	* [Customizing Functionality](custom_quantum_functions.md)
	28	* [Keymap Overview](keymap.md)
	29
67cc5ceb	30	* [Hardware](hardware.md)
67cc5ceb	31	* [AVR Processors](hardware_avr.md)
67cc5ceb	32	* [Drivers](hardware_drivers.md)
67cc5ceb	33
da24a34e	34	* Reference
	35	* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
	36	* [Config Options](config_options.md)
	37	* [Keycodes](keycodes.md)
a25dd58b	38	* [Coding Conventions - C](coding_conventions_c.md)
a25dd58b	39	* [Coding Conventions - Python](coding_conventions_python.md)
da24a34e	40	* [Documentation Best Practices](documentation_best_practices.md)
	41	* [Documentation Templates](documentation_templates.md)
	42	* [Glossary](reference_glossary.md)
	43	* [Unit Testing](unit_testing.md)
eb19fb5b	44	* [Useful Functions](ref_functions.md)
d8f090e5	45	* [Configurator Support](reference_configurator_support.md)
330e2e6a	46	* [info.json Format](reference_info_json.md)
a25dd58b	47	* [Python Development](python_development.md)
da24a34e	48
14c5160b	49	* [Features](features.md)
da24a34e	50	* [Basic Keycodes](keycodes_basic.md)
59b2be62	51	* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
da24a34e	52	* [Quantum Keycodes](quantum_keycodes.md)
67cc5ceb	53	* [Advanced Keycodes](feature_advanced_keycodes.md)
67cc5ceb	54	* [Audio](feature_audio.md)
bf1fedc0	55	* [Auto Shift](feature_auto_shift.md)
9b879b12	56	* [Backlight](feature_backlight.md)
da24a34e	57	* [Bluetooth](feature_bluetooth.md)
9b879b12	58	* [Bootmagic](feature_bootmagic.md)
c97315dc	59	* [Combos](feature_combo.md)
e87c39d3	60	* [Command](feature_command.md)
dcb274b2	61	* [Debounce API](feature_debounce_type.md)
67cc5ceb	62	* [Dynamic Macros](feature_dynamic_macros.md)
85688e5b	63	* [Encoders](feature_encoders.md)
8b186233	64	* [Grave Escape](feature_grave_esc.md)
02787ac0	65	* [Haptic Feedback](feature_haptic_feedback.md)
dcb274b2	66	* [HD44780 LCD Controller](feature_hd44780.md)
67cc5ceb	67	* [Key Lock](feature_key_lock.md)
67cc5ceb	68	* [Layouts](feature_layouts.md)
9d1a08e3	69	* [Leader Key](feature_leader_key.md)
3305df8e	70	* [LED Matrix](feature_led_matrix.md)
67cc5ceb	71	* [Macros](feature_macros.md)
7b0356d1	72	* [Mouse Keys](feature_mouse_keys.md)
c97315dc	73	* [OLED Driver](feature_oled_driver.md)
da24a34e	74	* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
cfd118d1	75	* [Pointing Device](feature_pointing_device.md)
7b0356d1	76	* [PS/2 Mouse](feature_ps2_mouse.md)
bf1fedc0	77	* [RGB Lighting](feature_rgblight.md)
e0c9cfad	78	* [RGB Matrix](feature_rgb_matrix.md)
c745d9b8	79	* [Space Cadet](feature_space_cadet.md)
311d625c	80	* [Split Keyboard](feature_split_keyboard.md)
67cc5ceb	81	* [Stenography](feature_stenography.md)
7b80aea8	82	* [Swap Hands](feature_swap_hands.md)
67cc5ceb	83	* [Tap Dance](feature_tap_dance.md)
7ad924ba	84	* [Terminal](feature_terminal.md)
67cc5ceb	85	* [Thermal Printer](feature_thermal_printer.md)
	86	* [Unicode](feature_unicode.md)
	87	* [Userspace](feature_userspace.md)
c1c5922a	88	* [Velocikey](feature_velocikey.md)
26fb063b	89
9cadba7b	90	* For Makers and Modders
38261920	91	* [Hand Wiring Guide](hand_wire.md)
7b0356d1	92	* [ISP Flashing Guide](isp_flashing_guide.md)
ac7b2d92	93	* [ARM Debugging Guide](arm_debugging.md)
40836140	94	* [I2C Driver](i2c_driver.md)
3cf179be JH	95	* [GPIO Controls](internals_gpio_control.md)
3cf179be JH	96	* [Proton C Conversion](proton_c_conversion.md)
c12f1910	97
9cadba7b	98	* For a Deeper Understanding
9d1a08e3	99	* [How Keyboards Work](how_keyboards_work.md)
c12f1910	100	* [Understanding QMK](understanding_qmk.md)
26fb063b	101
9cadba7b	102	* Other Topics
e9ace148 DJ	103	* [Using Eclipse with QMK](other_eclipse.md)
e9ace148 DJ	104	* [Using VSCode with QMK](other_vscode.md)
2ad2b73d	105	* [Support](support.md)
7c9d5ace	106
ae7284ed JH	107	* QMK Internals (In Progress)
	108	* [Defines](internals_defines.md)
	109	* [Input Callback Reg](internals_input_callback_reg.md)
	110	* [Midi Device](internals_midi_device.md)
	111	* [Midi Device Setup Process](internals_midi_device_setup_process.md)
	112	* [Midi Util](internals_midi_util.md)
	113	* [Send Functions](internals_send_functions.md)
	114	* [Sysex Tools](internals_sysex_tools.md)