switch shift and enter thumb key

[qmk_firmware.git] / README.md

diff --git a/README.md b/README.md
index 613bdcf42b03c4b9d51c40d0ba28eaa0e42ddba2..f5c271f165fc39c45a3b467fd3256e4cc687a9a6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -274,7 +274,7 @@ This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboar
 
 ## International Characters on Windows
 
-[AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys amont others.
+[AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys among others.
 
 The method does not require Unicode support in the keyboard itself but depends instead of AutoHotkey running in the background.
 
@@ -304,7 +304,7 @@ For this mod, you need an unused pin wiring to DI of WS2812 strip. After wiring
 
 Please note that the underglow is not compatible with audio output. So you cannot enable both of them at the same time.
 
-Please add the following options into your config.h, and set them up according your hardware configuration.
+Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the F4 by default:
 
     #define ws2812_PORTREG  PORTF
     #define ws2812_DDRREG   DDRF
@@ -314,6 +314,12 @@ Please add the following options into your config.h, and set them up according y
     #define RGBLIGHT_SAT_STEP 17
     #define RGBLIGHT_VAL_STEP 17
 
+You'll need to edit `PORTF`, `DDRF`, and `PF4` on the first three lines to the port/pin you have your LED(s) wired to, eg for B3 change things to:
+
+    #define ws2812_PORTREG  PORTB
+    #define ws2812_DDRREG   DDRB
+    #define ws2812_pin PB3
+
 The firmware supports 5 different light effects, and the color (hue, saturation, brightness) can be customized in most effects. To control the underglow, you need to modify your keymap file to assign those functions to some keys/key combinations. For details, please check this keymap. `keyboard/planck/keymaps/yang/keymap.c`
 
 ### WS2812 Wiring