2017-07-27 18:59:17 +00:00
|
|
|
* [Getting started](README.md)
|
2017-08-06 03:54:34 +00:00
|
|
|
* [QMK Introduction](getting_started_introduction.md)
|
|
|
|
|
* [Install Build Tools](getting_started_build_tools.md)
|
|
|
|
|
* Alternative: [Vagrant Guide](getting_started_vagrant_guide.md)
|
|
|
|
|
* [Build/Compile instructions](getting_started_make_guide.md)
|
|
|
|
|
* [How to Use Github](getting_started_github.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)
|
2017-06-10 18:58:55 +00:00
|
|
|
|
2017-07-17 19:01:33 +00:00
|
|
|
* [Features](features.md)
|
2017-06-29 14:35:09 +00:00
|
|
|
* [Layer switching](key_functions.md)
|
|
|
|
|
* [Leader Key](leader_key.md)
|
|
|
|
|
* [Macros](macros.md)
|
|
|
|
|
* [Dynamic Macros](dynamic_macros.md)
|
|
|
|
|
* [Space Cadet](space_cadet_shift.md)
|
|
|
|
|
* [Tap Dance](tap_dance.md)
|
|
|
|
|
* [Mouse keys](mouse_keys.md)
|
2017-07-03 19:39:15 +00:00
|
|
|
* [Unicode](unicode.md)
|
2017-07-27 18:59:17 +00:00
|
|
|
* [Stenography](stenography.md)
|
2017-08-06 09:09:34 +00:00
|
|
|
* [Key Lock](key_lock.md)
|
2017-06-10 18:58:55 +00:00
|
|
|
|
2017-06-29 14:35:09 +00:00
|
|
|
* Reference
|
2017-06-30 02:12:24 +00:00
|
|
|
* [Glossary](glossary.md)
|
2017-06-29 14:35:09 +00:00
|
|
|
* [Keymap overview](keymap.md)
|
|
|
|
|
* [Keycodes](keycodes.md)
|
|
|
|
|
* [Basic Keycodes](basic_keycodes.md)
|
|
|
|
|
* [Quantum Keycodes](quantum_keycodes.md)
|
2017-07-03 19:39:15 +00:00
|
|
|
* [The `config.h` File](config_options.md)
|
2017-06-29 17:46:23 +00:00
|
|
|
* [Customizing Functionality](custom_quantum_functions.md)
|
2017-07-03 08:30:36 +00:00
|
|
|
* [Documentation Best Practices](documentation_best_practices.md)
|
2017-07-03 19:39:15 +00:00
|
|
|
* [Unit Testing](unit_testing.md)
|
2017-07-27 18:59:17 +00:00
|
|
|
|
2017-07-03 19:39:15 +00:00
|
|
|
* For Makers and Modders
|
2017-06-29 14:35:09 +00:00
|
|
|
* [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
|
|
|
|
|
* [Adding features to QMK](adding_features_to_qmk.md)
|
2017-07-03 19:39:15 +00:00
|
|
|
* [Hand Wiring Guide](hand_wiring.md)
|
2017-06-29 14:35:09 +00:00
|
|
|
* [ISP flashing guide](isp_flashing_guide.md)
|
2017-07-03 19:39:15 +00:00
|
|
|
* [Modding your keyboard](modding_your_keyboard.md)
|
|
|
|
|
* [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
|
2017-07-03 19:30:26 +00:00
|
|
|
|
2017-07-03 19:39:15 +00:00
|
|
|
* For a Deeper Understanding
|
2017-07-03 19:30:26 +00:00
|
|
|
* [How Keyboards Work](basic_how_keyboards_work.md)
|
|
|
|
|
* [Understanding QMK](understanding_qmk.md)
|
2017-07-27 18:59:17 +00:00
|
|
|
|
2017-07-03 19:39:15 +00:00
|
|
|
* Other Topics
|
2017-06-29 14:35:09 +00:00
|
|
|
* [Using Eclipse with QMK](eclipse.md)
|
