diff options
| author | Joshua Diamond <josh@windowoffire.com> | 2022-09-06 17:42:43 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-06 17:42:43 -0400 |
| commit | a4d1d8b7450e409d007f6e795ffb1cee42a8e511 (patch) | |
| tree | 565467087111070e36c2b72fe0a8f18dad6563a8 /docs | |
| parent | dc4af81e0b375b559d270bbeb3495d61933f8c54 (diff) | |
Resolve conflict merging master to develop (#18297)
* Discourage use of ENCODER_MAP at keyboard level (#18286)
* Discourage use of ENCODER_MAP at keyboard level
* Update docs/feature_encoders.md
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* Fungo rev1: fix QMK Configurator key sequence (#18293)
* info.json: correct JSON syntax; friendly formatting
* info.json: fix key sequence
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_encoders.md | 4 | ||||
| -rw-r--r-- | docs/pr_checklist.md | 3 |
2 files changed, 6 insertions, 1 deletions
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md index f93ab9fd2d..60b613d6a5 100644 --- a/docs/feature_encoders.md +++ b/docs/feature_encoders.md @@ -69,7 +69,7 @@ Additionally, if one side does not have an encoder, you can specify `{}` for the ## Encoder map :id=encoder-map -Encoder mapping may be added to your `keymap.c`, which replicates the normal keyswitch layer handling functionality, but with encoders. Add this to your `rules.mk`: +Encoder mapping may be added to your `keymap.c`, which replicates the normal keyswitch layer handling functionality, but with encoders. Add this to your keymap's `rules.mk`: ```make ENCODER_MAP_ENABLE = yes @@ -88,6 +88,8 @@ const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = { #endif ``` +?> This should only be enabled at the keymap level. + Using encoder mapping pumps events through the normal QMK keycode processing pipeline, resulting in a _keydown/keyup_ combination pushed through `process_record_xxxxx()`. To configure the amount of time between the encoder "keyup" and "keydown", you can add the following to your `config.h`: ```c diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md index ae5cb5eef6..1034631863 100644 --- a/docs/pr_checklist.md +++ b/docs/pr_checklist.md @@ -67,6 +67,9 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard - no `(-/+size)` comments related to enabling features - remove the list of alternate bootloaders if one has been specified - no re-definitions of the default MCU parameters if same value, when compared to the equivalent MCU in [mcu_selection.mk](https://github.com/qmk/qmk_firmware/blob/master/builddefs/mcu_selection.mk) + - no "keymap only" features enabled + - `COMBO_ENABLE` + - `ENCODER_MAP_ENABLE` - keyboard `config.h` - don't repeat `MANUFACTURER` in the `PRODUCT` value - no `#define DESCRIPTION` |