document upgrade to zmk-helpers v2

This commit is contained in:
urob 2024-04-20 21:28:31 -04:00
parent b4ff51c174
commit 34caadba56

View file

@ -11,7 +11,7 @@ compatible with Zephyr 3.0 is available
## Highlights
- clean keymap + unicode setup using helper macros from
[zmk-nodefree-config](https://github.com/urob/zmk-nodefree-config)
[zmk-helpers](https://github.com/urob/zmk-helpers)
- the base keymap and combo setup are independent of the physical location of
keys and are re-used for multiple keyboards. The configuration is fit onto
larger boards by padding it via a modular structure of "extra keys"
@ -98,18 +98,18 @@ This is great but there are still a few rough edges:
false negatives when typing fast.
Here's my configuration (I use a bunch of
[helper macros](https://github.com/urob/zmk-nodefree-config) to simplify the
[helper macros](https://github.com/urob/zmk-helpers) to simplify the
syntax, but they are not necessary):
```C++
/* use helper macros to define left and right hand keys */
#include "../zmk-nodefree-config/keypos_def/keypos_36keys.h" // keyposition helpers
#include "zmk-helpers/key-labels/36.h" // key-position labels
#define KEYS_L LT0 LT1 LT2 LT3 LT4 LM0 LM1 LM2 LM3 LM4 LB0 LB1 LB2 LB3 LB4 // left-hand keys
#define KEYS_R RT0 RT1 RT2 RT3 RT4 RM0 RM1 RM2 RM3 RM4 RB0 RB1 RB2 RB3 RB4 // right-hand keys
#define THUMBS LH2 LH1 LH0 RH0 RH1 RH2 // thumb keys
/* left-hand HRMs */
ZMK_BEHAVIOR(hml, hold_tap,
ZMK_HOLD_TAP(hml,
flavor = "balanced";
tapping-term-ms = <280>;
quick-tap-ms = <175>; // repeat on tap-into-hold
@ -120,7 +120,7 @@ ZMK_BEHAVIOR(hml, hold_tap,
)
/* right-hand HRMs */
ZMK_BEHAVIOR(hmr, hold_tap,
ZMK_HOLD_TAP(hmr,
flavor = "balanced";
tapping-term-ms = <280>;
quick-tap-ms = <175>; // repeat on tap-into-hold