aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index ab7373023..6e1ab9bc5 100644
--- a/README.md
+++ b/README.md
@@ -16,13 +16,21 @@ The documentation below explains QMK customizations and elaborates on some of th
16* If you're looking to customize a keyboard that currently runs QMK or TMK, find your keyboard's directory under `keyboard/` and run the make commands from there. 16* If you're looking to customize a keyboard that currently runs QMK or TMK, find your keyboard's directory under `keyboard/` and run the make commands from there.
17* If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh <project_name>`, which will create `/keyboard/<project_name>` with all the necessary components for a Quantum project. 17* If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh <project_name>`, which will create `/keyboard/<project_name>` with all the necessary components for a Quantum project.
18 18
19### Makefile Options
20
19You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you. 21You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you.
20 22
21 BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality 23 BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
22 MIDI_ENABLE = yes # MIDI controls 24 MIDI_ENABLE = yes # MIDI controls
23 # UNICODE_ENABLE = yes # Unicode support - this is commented out, just as an example. You have to use #, not // 25 UNICODE_ENABLE = no # <-- This is how you disable an option, just set it to "no"
24 BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID 26 BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
25 27
28### Customizing Makefile options on a per-keymap basis
29
30If your keymap directory has a file called `makefile.mk` (note the lowercase filename, and the `.mk` extension), any Makefile options you set in that file will take precedence over other Makefile options (those set for Quantum as a whole or for your particular keyboard).
31
32So let's say your keyboard's makefile has `CONSOLE_ENABLE = yes` (or maybe doesn't even list the `CONSOLE_ENABLE` option, which would cause it to revert to the global Quantum default). You want your particular keymap to not have the debug console, so you make a file called `makefile.mk` and specify `CONSOLE_ENABLE = no`.
33
26## Quick aliases to common actions 34## Quick aliases to common actions
27 35
28Your keymap can include shortcuts to common operations (called "function actions" in tmk). 36Your keymap can include shortcuts to common operations (called "function actions" in tmk).
@@ -199,6 +207,10 @@ This will clear all mods currently pressed.
199 207
200This will clear all keys besides the mods currently pressed. 208This will clear all keys besides the mods currently pressed.
201 209
210* `update_tri_layer(layer_1, layer_2, layer_3);`
211
212If the user attempts to activate layer 1 AND layer 2 at the same time (for example, by hitting their respective layer keys), layer 3 will be activated. Layers 1 and 2 will _also_ be activated, for the purposes of fallbacks (so a given key will fall back from 3 to 2, to 1 -- and only then to 0).
213
202#### Timer functionality 214#### Timer functionality
203 215
204It's possible to start timers and read values for time-specific events - here's an example: 216It's possible to start timers and read values for time-specific events - here's an example:
@@ -292,7 +304,7 @@ For this mod, you need an unused pin wiring to DI of WS2812 strip. After wiring
292 304
293Please note that the underglow is not compatible with audio output. So you cannot enable both of them at the same time. 305Please note that the underglow is not compatible with audio output. So you cannot enable both of them at the same time.
294 306
295Please add the following options into your config.h, and set them up according your hardware configuration. 307Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the F4 by default:
296 308
297 #define ws2812_PORTREG PORTF 309 #define ws2812_PORTREG PORTF
298 #define ws2812_DDRREG DDRF 310 #define ws2812_DDRREG DDRF
@@ -302,6 +314,12 @@ Please add the following options into your config.h, and set them up according y
302 #define RGBLIGHT_SAT_STEP 17 314 #define RGBLIGHT_SAT_STEP 17
303 #define RGBLIGHT_VAL_STEP 17 315 #define RGBLIGHT_VAL_STEP 17
304 316
317You'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:
318
319 #define ws2812_PORTREG PORTB
320 #define ws2812_DDRREG DDRB
321 #define ws2812_pin PB3
322
305The 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` 323The 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`
306 324
307### WS2812 Wiring 325### WS2812 Wiring