aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/crkbd/keymaps/rpbaptist/readme.md
diff options
context:
space:
mode:
authorRichard Baptist <rpbaptist@users.noreply.github.com>2020-03-10 07:40:27 +0100
committerGitHub <noreply@github.com>2020-03-09 23:40:27 -0700
commita4fd5e2491aa7213d15ef2ff3615b8eb75660e93 (patch)
tree1da00bb7b00f8e9df612ac87aac48b44caaa3751 /keyboards/crkbd/keymaps/rpbaptist/readme.md
parent5e3951b361e6d173b705bd3b2b6df0c543258d98 (diff)
downloadfirmware-a4fd5e2491aa7213d15ef2ff3615b8eb75660e93.tar.gz
firmware-a4fd5e2491aa7213d15ef2ff3615b8eb75660e93.tar.bz2
firmware-a4fd5e2491aa7213d15ef2ff3615b8eb75660e93.zip
[Keymap] Update personal keymap (#8354)
Diffstat (limited to 'keyboards/crkbd/keymaps/rpbaptist/readme.md')
-rw-r--r--keyboards/crkbd/keymaps/rpbaptist/readme.md47
1 files changed, 31 insertions, 16 deletions
diff --git a/keyboards/crkbd/keymaps/rpbaptist/readme.md b/keyboards/crkbd/keymaps/rpbaptist/readme.md
index cb53e75f2..b9e749b5c 100644
--- a/keyboards/crkbd/keymaps/rpbaptist/readme.md
+++ b/keyboards/crkbd/keymaps/rpbaptist/readme.md
@@ -10,27 +10,29 @@ Many thanks to foostan for the keyboard, all QMK contributors and drashna specif
### COLEMAKDHM
-Main typing layer. I really love having SHIFT available on thumbs. I am a left thumb space bar person, so I put SPACE there and ENTER on right. I use CTRL key combos lot in my text editor and desktop environment. That's why I have two of them. I also found them to be a great position for the square brackets. (`[` and `]`)
+Main typing layer. I really love having SHIFT available on thumbs. I am a left thumb space bar person, so I put SPACE there and ENTER on right. I use CTRL key combos lot in my text editor and desktop environment. That's why I have two of them. I also found them to be a great position for the square brackets. (`[` and `]`). These become parenthesis (`(` and `)`) on either of the layers.
-I don't know about you but "lower" and "raise" don't mean that much to me. I named my layers `NUM`, short for numbers and `NAV`, short for navigation. Holding the key will activate the layer for as long as it is held, double tapping it will switch to it. Single tapping it once will switch to main layer again.
+Holding SHIFT while tapping BACKSPACE will output DEL. Holding both SHIFT keys will output SHIFT+DEL.
-Everything else is pretty standard I'd say.
+I don't know about you but "lower" and "raise" don't mean that much to me. I named my layers `SYM`, short for symbols and `NAV`, short for navigation. Holding the key will activate the layer for as long as it is held, double tapping it will switch to it. Single tapping it once will switch to main layer again.
-### NUM
+Holding TAB will access `NUM` layer which features a numpad.
+
+### SYM
Includes a number row, the symbols normally on SHIFT and numbers, as well as a numpad under right side homing keys.
### NAV
-This is where I access arrow keys, page up, down, home, end and mouse control. I also added general tab forward and backward keys. I use these in my browser, terminal and text editor.
+This is where I access arrow keys, page up, down, home, end and F keys. I also added general tab forward and backward keys. Tab close and window close. I primarily use these in my browser, terminal and text editor.
-## FN
+### UTIL
-Short for function. This gives access to the function keys, as well as rarely used keys on the left side and often used symbols (for me) on the right side. It is accessed by holding TAB.
+Short for utility. This is accessed by pressing both `SYM` and `NAV` at the same time. It has a software `RESET` key, media keys, RGB control and switches main layer between Colemak and a gaming layer.
-### UTIL
+### NUMPAD
-Short for utility. This is accessed by pressing both `NUM` and `NAV` at the same time. It has a software `RESET` key, media keys, RGB control and switches main layer between Colemak and a gaming layer.
+This gives access to a numpad on the right half with some additional symbols I find useful when using the numpad.
### GAMING
@@ -38,20 +40,33 @@ Sometimes I switch to type in Discord, Steam, or in game chat, so I think it's m
I put movement on FRST (would be ESDF on QWERTY), because it lines up more comfortably with the columnar staggered layout of the Corne. It also gives more easy access to all keys on left half.
-Most notable here is that there are no tap and hold differences anymore on left hand side besides the new layer key. This is a different layer than `NUM`.
+Most notable here is that there are no tap and hold differences anymore on left hand side besides the new layer key. This is a different layer than `SYM`.
### GAMING_EXT
-This is the gaming extended layer where movement keys remain the same. This means I can keep moving while accessing second layer keys. All other keys are keys on which I can easily rebind something. Besides that it gives me the function keys and an ENTER key which does not change. This is good when a game requires you to hold ENTER.
+This is the gaming extended layer where movement keys remain the same. This means I can keep moving while accessing second layer keys. All other keys are keys on which I can easily rebind something. Besides that it gives me an ENTER key which does not switch. This is good when a game requires you to hold ENTER.
-## Notes
+## RGB
+
+I took a big inspiration from Drashna's RGB configuration and tweaked it.
-I use MT3 Godspeed caps and thought it would be fun to theme the OLED output towards it. The slave side has the icon and two planets. The left side refers to modifiers by matching the novelty mod legends.
+- `RGB_UND`: Toggles underglow indicators on and off. Each layer has its own color.
+- `RGB_IDL`: This will enable/disable idle mode. By default, when typing, the `DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS` will be used. When the idle timeout has exceeded the secondary animation will be activated, which is `RGB_MATRIX_CYCLE_ALL` by default. When switching to `GAMING` layer the timeout will be reduced and the idle animation changed to `RGB_MATRIX_RAINBOW_PINWHEELS`.
+ When idle mode is enabled, `RGB_MATRIX_TYPING_HEATMAP` and `RGB_MATRIX_MULTISPLASH` will be used for active animation. All others for idle animation. When disabling idle mode, the current idle animation will be activated. Additionally, on idling, the underglow layer indication will be deactivated.
+- There are no RGB mode cycle keys, but instead several keys to use a specific RGB directly. Each has their own default speed, although this can be changed.
## Building
-I am using DFU and have to flash both halves individually.
+`make crkbd/rev1:rpbaptist:dfu`
+
+## Notes
+
+I use several OLED slave side images, depending on the keycaps I am using. These also determine the default LED color and underglow.
+
+`make crkbd/rev1:rpbaptist:dfu THEME=pulse`
-Left half: `make crkbd/rev1:rpbaptist:dfu-split-left`
+Current supported themes are:
-Right half: `make crkbd/rev1:rpbaptist:dfu-split-right RGB_MATRIX_SPLIT_RIGHT=yes`
+- godspeed
+- laser
+- pulse