summaryrefslogtreecommitdiffstats
path: root/docs/SUMMARY.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-05-28 00:09:52 +0200
committerJack Humbert <jack.humb@gmail.com>2017-05-28 00:09:52 +0200
commit704794bae3bf96541b0362ea38b84706d5ee6958 (patch)
tree866be7a6a63cb8e5f6f7c236303a796239ed9eae /docs/SUMMARY.md
parentd24da945d1dbfbe81177dd6611b0d5a27ab8344f (diff)
parente229dcadb5c9f8c09f14a439fe5a4c7c48ba2249 (diff)
downloadqmk_firmware-704794bae3bf96541b0362ea38b84706d5ee6958.tar.gz
qmk_firmware-704794bae3bf96541b0362ea38b84706d5ee6958.tar.xz
subtree docs
Diffstat (limited to 'docs/SUMMARY.md')
-rw-r--r--docs/SUMMARY.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
new file mode 100644
index 000000000..99845a7b6
--- /dev/null
+++ b/docs/SUMMARY.md
@@ -0,0 +1,26 @@
+
+### Getting started
+* [Introduction](/Home.md)
+* [QMK Overview](/QMK-Overview.md)
+* [Build Environment Setup](/Build-Environment-Setup.md)
+
+### Making a keymap
+* [Keymap overview](/Keymap.md)
+* [Keycodes](/Keycodes.md)
+* [Layer switching](/Key-Functions.md)
+* [Leader Key](/Leader-Key.md)
+* [Macros](/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)
+
+### For hardware makers and modders
+* [Modding your keyboard](/Modding-your-keyboard.md)
+* [Porting your keyboard to QMK](/Porting-your-keyboard-to-QMK.md)
+* [Adding features to QMK](/Adding-features-to-QMK.md)
+
+### Other topics
+* [General FAQ](/FAQ.md)
+* [Differences from TMK](/Differences-from-TMK.md)