From 60cac6d93811e931eea4438f04c2029d140afe96 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Tue, 6 Sep 2022 18:08:48 +0100 Subject: 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 Co-authored-by: Ryan --- docs/feature_encoders.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/feature_encoders.md') 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 `.c`: -- cgit v1.2.3