diff options
| author | Joel Challis <git@zvecr.com> | 2022-09-06 18:08:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-09-06 18:08:48 +0100 |
| commit | 60cac6d93811e931eea4438f04c2029d140afe96 (patch) | |
| tree | f14e4dcea319feeed43e04d21da896c1d1065aae /docs/feature_encoders.md | |
| parent | 712aa7b1cd1b02f586c163cad763ee4169b1f022 (diff) | |
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>
Diffstat (limited to 'docs/feature_encoders.md')
| -rw-r--r-- | docs/feature_encoders.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/feature_encoders.md b/docs/feature_encoders.md index fdde03ac23..2e4a4fe324 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. + ## Callbacks When not using `ENCODER_MAP_ENABLE = yes`, the callback functions can be inserted into your `<keyboard>.c`: |