]> git.donarmstrong.com Git - qmk_firmware.git/blob - docs/_summary.md
72deb9ba56aede4d81d16f28cfd1b092524538b2
[qmk_firmware.git] / docs / _summary.md
1 * [Getting started](README.md)
2   * [QMK Introduction](getting_started_introduction.md)
3   * [Install Build Tools](getting_started_build_tools.md)
4     * Alternative: [Vagrant Guide](getting_started_vagrant_guide.md)
5   * [Build/Compile instructions](getting_started_make_guide.md)
6   * [How to Use Github](getting_started_github.md)
7
8 * [FAQ](faq.md)
9   * [General FAQ](faq_general.md)
10   * [Build/Compile QMK](faq_build.md)
11   * [Debugging/Troubleshooting QMK](faq_debug.md)
12   * [Keymap](faq_keymap.md)
13
14 * [Features](features.md)
15   * [Layer switching](key_functions.md)
16   * [Leader Key](leader_key.md)
17   * [Macros](macros.md)
18   * [Dynamic Macros](dynamic_macros.md)
19   * [Space Cadet](space_cadet_shift.md)
20   * [Tap Dance](tap_dance.md)
21   * [Mouse keys](mouse_keys.md)
22   * [Unicode](unicode.md)
23   * [Stenography](stenography.md)
24   * [Key Lock](key_lock.md)
25
26 * Reference
27   * [Glossary](glossary.md)
28   * [Keymap overview](keymap.md)
29   * [Keycodes](keycodes.md)
30     * [Basic Keycodes](basic_keycodes.md)
31     * [Quantum Keycodes](quantum_keycodes.md)
32   * [The `config.h` File](config_options.md)
33   * [Customizing Functionality](custom_quantum_functions.md)
34   * [Documentation Best Practices](documentation_best_practices.md)
35   * [Unit Testing](unit_testing.md)
36
37 * For Makers and Modders
38   * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
39   * [Adding features to QMK](adding_features_to_qmk.md)
40   * [Hand Wiring Guide](hand_wiring.md)
41   * [ISP flashing guide](isp_flashing_guide.md)
42   * [Modding your keyboard](modding_your_keyboard.md)
43   * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
44
45 * For a Deeper Understanding
46   * [How Keyboards Work](basic_how_keyboards_work.md)
47   * [Understanding QMK](understanding_qmk.md)
48
49 * Other Topics
50   * [Using Eclipse with QMK](eclipse.md)