qmk

QMK Firmware
git clone git://git.z3bra.org/qmk.git
Log | Files | Refs | Submodules | LICENSE

_summary.md (4556B)


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