1
0
Fork 0

Restructure the hardware and feature docs to make things easier to find (#1888)

* fix #1313 by documenting more config.h options

* Clean up and organize documentation
This commit is contained in:
skullydazed 2017-10-24 20:34:28 -07:00 committed by GitHub
parent 8892c50336
commit 67cc5cebc0
23 changed files with 508 additions and 328 deletions

View file

@ -36,7 +36,7 @@ An alternative keyboard layout developed by Dr. August Dvorak in the 1930's. A s
## 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.
* [Dynamic Macro Documentation](dynamic_macros.html)
* [Dynamic Macro Documentation](feature_dynamic_macros.md)
## Eclipse
An IDE that is popular with many C developers.
@ -93,7 +93,7 @@ A wiring pattern of columns and rows that enables the MCU to detect keypresses w
## Macro
A feature that lets you send muiltple keypress events (hid reports) after having pressed only a single key.
* [Macro Documentation](macros.html)
* [Macro Documentation](feature_macros.md)
## MCU
Microcontrol Unit, the processor that powers your keyboard.
@ -104,7 +104,7 @@ A key that is held down while typing another key to modify the action of that ke
## Mousekeys
A feature that lets you control your mouse cursor and click from your keyboard.
* [Mousekeys Documentation](mouse_keys.html)
* [Mousekeys Documentation](feature_mouse_keys.html)
## N-Key Rollover (NKRO)
A term that applies to keyboards that are capable of reporting any number of key-presses at once.
@ -133,7 +133,7 @@ A 1 byte number that is sent as part of a HID report over USB that represents a
## Space Cadet Shift
A special set of shift keys which allow you to type various types of braces by tapping the left or right shift one or more times.
* [Space Cadet Shift Documentation](space_cadet_shift.html)
* [Space Cadet Shift Documentation](feature_space_cadet.html)
## Tap
Pressing and releasing a key. In some situations you will need to distinguish between a key down and a key up event, and Tap always refers to both at once.
@ -141,7 +141,7 @@ Pressing and releasing a key. In some situations you will need to distinguish be
## 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.md)
* [Tap Dance Documentation](feature_tap_dance.md)
## Teensy
A low-cost AVR development board that is commonly used for hand-wired builds. A teensy is often chosen despite costing a few dollors more due to its halfkay bootloader, which makes flashing very simple.
@ -152,7 +152,7 @@ A generic term for LEDs that light the underside of the board. These LED's typic
## Unicode
In the larger computer world Unicode is a set of encoding schemes for representing characters in any language. As it relates to QMK it means using various OS schemes to send unicode codepoints instead of scancodes.
* [Unicode Documentation](unicode.md)
* [Unicode Documentation](feature_unicode.md)
## Unit Testing
A framework for running automated tests against QMK. Unit testing helps us be confident that our changes do not break anything.