diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/feature_mouse_keys.md | 2 | ||||
-rw-r--r-- | docs/glossary.md | 2 | ||||
-rw-r--r-- | docs/understanding_qmk.md | 6 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md index 9e7df929e..673eafaef 100644 --- a/docs/feature_mouse_keys.md +++ b/docs/feature_mouse_keys.md | |||
@@ -40,7 +40,7 @@ You can use these keycodes within your keymap to map button presses to mouse act | |||
40 | |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| | 40 | |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| |
41 | |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| | 41 | |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| |
42 | 42 | ||
43 | You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46 | 43 | You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/keymap.c#L46 |
44 | 44 | ||
45 | ## Configuring the Behavior of Mousekeys | 45 | ## Configuring the Behavior of Mousekeys |
46 | 46 | ||
diff --git a/docs/glossary.md b/docs/glossary.md index c8c54d6de..754c1469e 100644 --- a/docs/glossary.md +++ b/docs/glossary.md | |||
@@ -4,7 +4,7 @@ | |||
4 | A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI. | 4 | A line of 32-bit MCU's produced by a number of companies, such as Atmel, Cypress, Kinetis, NXP, ST, and TI. |
5 | 5 | ||
6 | ## AVR | 6 | ## AVR |
7 | A line of 8-bit MCU's produced by [Atmel](http://atmel.com). AVR was the original platform that TMK supported. | 7 | A line of 8-bit MCU's produced by [Atmel](http://www.microchip.com/). AVR was the original platform that TMK supported. |
8 | 8 | ||
9 | ## AZERTY | 9 | ## AZERTY |
10 | The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard. | 10 | The standard Français (French) keyboard layout. Named for the first 6 keys on the keyboard. |
diff --git a/docs/understanding_qmk.md b/docs/understanding_qmk.md index 13b6e2ef6..4544cb260 100644 --- a/docs/understanding_qmk.md +++ b/docs/understanding_qmk.md | |||
@@ -77,7 +77,7 @@ At the keyboard level we define a C macro (typically named `KEYMAP()`) which map | |||
77 | 77 | ||
78 | Notice how the second block of our `KEYMAP()` macro matches the Matrix Scanning array above? This macro is what will map the matrix scanning array to keycodes. However, if you look at a 17 key numpad you'll notice that it has 3 places where the matrix could have a switch but doesn't, due to larger keys. We have populated those spaces with `KC_NO` so that our keymap definition doesn't have to. | 78 | Notice how the second block of our `KEYMAP()` macro matches the Matrix Scanning array above? This macro is what will map the matrix scanning array to keycodes. However, if you look at a 17 key numpad you'll notice that it has 3 places where the matrix could have a switch but doesn't, due to larger keys. We have populated those spaces with `KC_NO` so that our keymap definition doesn't have to. |
79 | 79 | ||
80 | You can also use this macro to handle unusual matrix layouts, for example the [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/rev2/rev2.h). Explaining that is outside the scope of this document. | 80 | You can also use this macro to handle unusual matrix layouts, for example the [Clueboard rev 2](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/rev2/rev2.h). Explaining that is outside the scope of this document. |
81 | 81 | ||
82 | ##### Keycode Assignment | 82 | ##### Keycode Assignment |
83 | 83 | ||
@@ -135,8 +135,8 @@ The `process_record()` function itself is deceptively simple, but hidden within | |||
135 | * [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L128) | 135 | * [`void process_record(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/common/action.c#L128) |
136 | * [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L140) | 136 | * [`bool process_record_quantum(keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L140) |
137 | * [Map this record to a keycode](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L143) | 137 | * [Map this record to a keycode](https://github.com/qmk/qmk_firmware/blob/master/quantum/quantum.c#L143) |
138 | * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/cluecard.c#L20) | 138 | * [`bool process_record_kb(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/card.c#L20) |
139 | * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/cluecard/keymaps/default/keymap.c#L58) | 139 | * [`bool process_record_user(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/card/keymaps/default/keymap.c#L58) |
140 | * [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_midi.c#L102) | 140 | * [`bool process_midi(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_midi.c#L102) |
141 | * [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_audio.c#L10) | 141 | * [`bool process_audio(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_audio.c#L10) |
142 | * [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_music.c#L69) | 142 | * [`bool process_music(uint16_t keycode, keyrecord_t *record)`](https://github.com/qmk/qmk_firmware/blob/master/quantum/process_keycode/process_music.c#L69) |