Updated QMK Overview (markdown)

[qmk_firmware.git] / Keycodes.md

diff --git a/Keycodes.md b/Keycodes.md
index 0db1792a23b166eb3425089330852d34c067376f..2ea6b315d4ab84684b713476fdd095172fdae7c4 100644 (file)
--- a/Keycodes.md
+++ b/Keycodes.md
@@ -1,3 +1,11 @@
+# Overview
+
+When defining a [keymap](https://github.com/qmk/qmk_firmware/blob/master/doc/keymap.md) each key needs a valid key definition. This page documents the symbols that correspond to keyboard scan codes that are available to you in QMK. They can be used by themselves or in combination with one of the [many functions available](https://github.com/qmk/qmk_firmware/wiki#going-beyond-the-keycodes) to customize your board.
+
+The source of truth for these codes is the [keycode.txt](https://github.com/qmk/qmk_firmware/blob/master/doc/keycode.txt) file in the qmk documentation.
+
+# The Keycodes
+
 ## Letters and Numbers
 
 |KC_1|KC_2|KC_3|KC_4|KC_5|KC_6|KC_7|KC_8|
@@ -41,11 +49,6 @@
 
 |Long Name|Short Name|Description|
 |---------|----------|-----------|
-|KC_LOCKING_CAPS||Locking Caps Lock12|
-|KC_LOCKING_NUM||Locking Num Lock12|
-|KC_LOCKING_SCROLL||Locking Scroll Lock12|
-|KC_INT4|KC_HENK|JIS Henken|
-|KC_INT5|KC_MHEN|JIS Muhenken|
 |KC_LCTRL|KC_LCTL|LeftControl|
 |KC_LSHIFT|KC_LSFT|LeftShift|
 |KC_LALT||LeftAlt|
@@ -54,6 +57,11 @@
 |KC_RSHIFT|KC_RSFT|RightShift|
 |KC_RALT||RightAlt|
 |KC_RGUI||Right GUI(Windows/Apple/Meta key)|
+|KC_LOCKING_CAPS||Locking Caps Lock12|
+|KC_LOCKING_NUM||Locking Num Lock12|
+|KC_LOCKING_SCROLL||Locking Scroll Lock12|
+|KC_INT4|KC_HENK|JIS Henken|
+|KC_INT5|KC_MHEN|JIS Muhenken|
 
 ## Commands