From 3e3c3e2b246737b9c29dc22764c1ac689130bb50 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 22:12:24 -0400 Subject: start glossary --- docs/glossary.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/glossary.md (limited to 'docs/glossary.md') diff --git a/docs/glossary.md b/docs/glossary.md new file mode 100644 index 0000000000..f69b1709bc --- /dev/null +++ b/docs/glossary.md @@ -0,0 +1,10 @@ +# Glossary of QMK terms + +git +: versioning software used at the commandline + +keymap +: an array of keycodes mapped to a physical keyboard layout, which are processed on key presses and releases + +matrix +: a wiring pattern of columns and rows (and usually diodes) that enables the MCU to detect keypresses with a fewer number of pins \ No newline at end of file -- cgit v1.2.3 From d8e29b53fe5d57f2102b77f0ce9932cdb8b021b2 Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 3 Jul 2017 01:30:36 -0700 Subject: Update a bunch of docs --- docs/glossary.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) (limited to 'docs/glossary.md') diff --git a/docs/glossary.md b/docs/glossary.md index f69b1709bc..fac1952a6d 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -1,10 +1,29 @@ # Glossary of QMK terms -git -: versioning software used at the commandline +## Dynamic Macro +A macro which has been recorded on the keyboard and which will be lost when the keyboard is unplugged or the computer rebooted. -keymap -: an array of keycodes mapped to a physical keyboard layout, which are processed on key presses and releases +## git +Versioning software used at the commandline -matrix -: a wiring pattern of columns and rows (and usually diodes) that enables the MCU to detect keypresses with a fewer number of pins \ No newline at end of file +## Keycode +A 2-byte number that represents a particular key. `0x00`-`0xFF` are used for [Basic Keycodes](keycodes.html) while `0x100`-`0xFFFF` are used for [Quantum Keycodes](quantum_keycodes.html). + +## Keymap +An array of keycodes mapped to a physical keyboard layout, which are processed on key presses and releases + +## Matrix +A wiring pattern of columns and rows (and usually diodes) that enables the MCU to detect keypresses with a fewer number of pins + +## Macro +A feature that lets you send muiltple keypress events (hid reports) after having pressed only a single key. + +## Mousekeys +A feature that lets you control your mouse cursor and click from your keyboard. + +* [Mousekeys Documentation](mouse_keys.html) + +## Tap Dance +A feature that lets you assign muiltple keycodes to the same key based on how many times you press it. + +* [Tap Dance Documentation](tap_dance.html) -- cgit v1.2.3