qmk_firmware/docs/_summary.md

175 lines
6.4 KiB
Markdown
Raw Normal View History

2020-02-25 18:58:36 +00:00
* Tutorial
2020-02-20 19:57:43 +00:00
* [Introduction](newbs.md)
2020-02-25 17:17:24 +00:00
* [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/Support](support.md)
2020-02-26 00:33:56 +00:00
* [Other Resources](newbs_learn_more_resources.md)
* [Syllabus](syllabus.md)
2020-02-20 19:06:27 +00:00
2020-02-20 19:57:43 +00:00
* FAQs
* [General FAQ](faq_general.md)
* [Build/Compile QMK](faq_build.md)
* [Debugging/Troubleshooting QMK](faq_debug.md)
2020-02-25 21:43:05 +00:00
* [Keymap FAQ](faq_keymap.md)
* [Glossary](reference_glossary.md)
2020-02-24 06:37:25 +00:00
* Configurator
* [Overview](newbs_building_firmware_configurator.md)
2020-02-25 18:58:36 +00:00
* [Step by Step](configurator_step_by_step.md)
* [Troubleshooting](configurator_troubleshooting.md)
2020-02-24 06:37:25 +00:00
* QMK API
* [Overview](api_overview.md)
* [API Documentation](api_docs.md)
2020-02-25 18:58:36 +00:00
* [Keyboard Support](reference_configurator_support.md)
2020-02-24 06:37:25 +00:00
2020-02-25 17:17:24 +00:00
* CLI
* [Overview](cli.md)
* [Configuration](cli_configuration.md)
* [Commands](cli_commands.md)
2020-02-20 19:57:43 +00:00
* Using QMK
* Guides
* [Customizing Functionality](custom_quantum_functions.md)
2020-02-25 17:17:24 +00:00
* [Driver Installation with Zadig](driver_installation_zadig.md)
2020-02-20 19:57:43 +00:00
* [Keymap Overview](keymap.md)
* Development Environments
* [Docker Guide](getting_started_docker.md)
* [Vagrant Guide](getting_started_vagrant.md)
2020-02-25 17:17:24 +00:00
* Flashing
2020-02-25 18:58:36 +00:00
* [Flashing](flashing.md)
2020-02-25 17:17:24 +00:00
* [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md)
2020-02-26 00:33:56 +00:00
* IDEs
* [Using Eclipse with QMK](other_eclipse.md)
* [Using VSCode with QMK](other_vscode.md)
2020-02-25 17:17:24 +00:00
* 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)
2020-02-20 19:57:43 +00:00
2020-02-25 17:17:24 +00:00
* Simple Keycodes
* [Full List](keycodes.md)
* [Basic Keycodes](keycodes_basic.md)
* [Language-Specific Keycodes](reference_keymap_extras.md)
* [Modifier Keys](feature_advanced_keycodes.md)
2020-02-25 17:17:24 +00:00
* [Quantum Keycodes](quantum_keycodes.md)
2020-02-25 17:17:24 +00:00
* Advanced Keycodes
* [Command](feature_command.md)
* [Dynamic Macros](feature_dynamic_macros.md)
* [Grave Escape](feature_grave_esc.md)
* [Leader Key](feature_leader_key.md)
* [Mod-Tap](mod_tap.md)
2020-02-25 17:17:24 +00:00
* [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)
2018-08-11 21:54:27 +00:00
2020-02-25 17:17:24 +00:00
* Software Features
2020-02-25 18:58:36 +00:00
* [Auto Shift](feature_auto_shift.md)
2020-02-25 17:17:24 +00:00
* [Combos](feature_combo.md)
* [Debounce API](feature_debounce_type.md)
* [Key Lock](feature_key_lock.md)
* [Layers](feature_layers.md)
* [One Shot Keys](one_shot_keys.md)
2020-02-25 17:17:24 +00:00
* [Pointing Device](feature_pointing_device.md)
* [Raw HID](feature_rawhid.md)
2020-02-25 17:17:24 +00:00
* [Swap Hands](feature_swap_hands.md)
* [Tap Dance](feature_tap_dance.md)
* [Tap-Hold Configuration](tap_hold.md)
2020-02-25 17:17:24 +00:00
* [Terminal](feature_terminal.md)
* [Unicode](feature_unicode.md)
* [Userspace](feature_userspace.md)
* [WPM Calculation](feature_wpm.md)
2020-02-25 17:17:24 +00:00
* Hardware Features
* Displays
2020-02-20 19:57:43 +00:00
* [HD44780 LCD Controller](feature_hd44780.md)
* [OLED Driver](feature_oled_driver.md)
2020-02-25 17:17:24 +00:00
* Lighting
* [Backlight](feature_backlight.md)
* [LED Matrix](feature_led_matrix.md)
2020-02-20 19:57:43 +00:00
* [RGB Lighting](feature_rgblight.md)
* [RGB Matrix](feature_rgb_matrix.md)
2020-02-25 17:17:24 +00:00
* [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)
2017-07-03 19:30:26 +00:00
2020-02-20 19:57:43 +00:00
* Developing QMK
2020-02-24 06:37:25 +00:00
* Breaking Changes
* [Overview](breaking_changes.md)
* [My Pull Request Was Flagged](breaking_changes_instructions.md)
* History
2020-05-30 20:14:59 +00:00
* [2020 May 30](ChangeLog/20200530.md)
* [2020 Feb 29](ChangeLog/20200229.md)
2020-02-24 06:37:25 +00:00
* [2019 Aug 30](ChangeLog/20190830.md)
2020-02-20 19:57:43 +00:00
* C Development
2020-02-25 17:17:24 +00:00
* [ARM Debugging Guide](arm_debugging.md)
2020-02-20 19:57:43 +00:00
* [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)
* [SPI Driver](spi_driver.md)
2020-02-20 19:57:43 +00:00
* [WS2812 Driver](ws2812_driver.md)
* [EEPROM Driver](eeprom_driver.md)
* ['serial' Driver](serial_driver.md)
2020-02-20 19:57:43 +00:00
* [GPIO Controls](internals_gpio_control.md)
* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
* Python Development
* [Coding Conventions](coding_conventions_python.md)
2020-02-25 17:17:24 +00:00
* [QMK CLI Development](cli_development.md)
2020-02-20 19:57:43 +00:00
2020-02-24 06:37:25 +00:00
* Configurator Development
* QMK API
* [Development Environment](api_development_environment.md)
* [Architecture Overview](api_development_overview.md)
* Hardware Platform Development
* Arm/ChibiOS
* [Early initialization](platformdev_chibios_earlyinit.md)
2020-02-25 17:17:24 +00:00
* 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)
* [Community Layouts](feature_layouts.md)
* [Unit Testing](unit_testing.md)
* [Useful Functions](ref_functions.md)
* [info.json Format](reference_info_json.md)
2020-02-20 19:57:43 +00:00
* For a Deeper Understanding
* [How Keyboards Work](how_keyboards_work.md)
* [How a Matrix Works](how_a_matrix_works.md)
2020-02-20 19:57:43 +00:00
* [Understanding QMK](understanding_qmk.md)
2020-02-20 19:57:43 +00:00
* 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)