summaryrefslogtreecommitdiff
path: root/docs/_summary.md
diff options
context:
space:
mode:
authorFabian Topfstedt <topfstedt@schneevonmorgen.com>2017-07-20 08:22:44 +0200
committerFabian Topfstedt <topfstedt@schneevonmorgen.com>2017-07-20 08:22:44 +0200
commitee43856ff7ba37ea89d1a8a4700efba4e4f69571 (patch)
treeb0ed5b538396b0b2b027e69ad8ceac443c067c79 /docs/_summary.md
parent99b6e918eab31d4f53cabc04a995da945335ac7f (diff)
parent14c5160b1a94d5dc416002791b3c207ba0dca789 (diff)
Merge https://github.com/qmk/qmk_firmware
Diffstat (limited to 'docs/_summary.md')
-rw-r--r--docs/_summary.md68
1 files changed, 41 insertions, 27 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 8e0a6f51ca..162cad7873 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -1,31 +1,45 @@
+* [Getting started](README.md)
+ * [QMK Overview](qmk_overview.md)
+ * [Build Environment Setup](build_environment_setup.md)
+ * [Vagrant Guide](vagrant_guide.md)
+ * [Make instructions](make_instructions.md)
+ * [FAQ: Creating a Keymap](faq_keymap.md)
+ * [FAQ: Compiling QMK](faq_build.md)
+ * [How to Github](how_to_github.md)
-### Getting started
-* [Introduction](home.md)
-* [QMK Overview](qmk_overview.md)
-* [Build Environment Setup](build_environment_setup.md)
-* [Make instructions](make_instructions.md)
+* [Features](features.md)
+ * [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)
+ * [Unicode](unicode.md)
-### Making a keymap
-* [Keymap overview](keymap.md)
-* [Custom Quantum Functions](custom_quantum_functions.md)
-* [Keycodes](keycodes.md)
-* [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)
-* [FAQ: Creating a Keymap](faq_keymap.md)
-* [FAQ: Compiling QMK](faq_build.md)
+* Reference
+ * [Glossary](glossary.md)
+ * [Keymap overview](keymap.md)
+ * [Keycodes](keycodes.md)
+ * [Basic Keycodes](basic_keycodes.md)
+ * [Quantum Keycodes](quantum_keycodes.md)
+ * [The `config.h` File](config_options.md)
+ * [Customizing Functionality](custom_quantum_functions.md)
+ * [Documentation Best Practices](documentation_best_practices.md)
+ * [Unit Testing](unit_testing.md)
-### For hardware makers and modders
-* [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
-* [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
-* [Modding your keyboard](modding_your_keyboard.md)
-* [Adding features to QMK](adding_features_to_qmk.md)
-* [ISP flashing guide](isp_flashing_guide.md)
+* For Makers and Modders
+ * [Adding a keyboard to QMK](adding_a_keyboard_to_qmk.md)
+ * [Adding features to QMK](adding_features_to_qmk.md)
+ * [Hand Wiring Guide](hand_wiring.md)
+ * [ISP flashing guide](isp_flashing_guide.md)
+ * [Modding your keyboard](modding_your_keyboard.md)
+ * [Porting your keyboard to QMK](porting_your_keyboard_to_qmk.md)
+
+* For a Deeper Understanding
+ * [How Keyboards Work](basic_how_keyboards_work.md)
+ * [Understanding QMK](understanding_qmk.md)
-### Other topics
-* [General FAQ](faq.md)
-* [Differences from TMK](differences_from_tmk.md)
+* Other Topics
+ * [General FAQ](faq.md)
+ * [Using Eclipse with QMK](eclipse.md)