diff --git a/README.md b/README.md index 571cf28..8e5b003 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,6 @@ particular order): - Python is awesome - Python is super easy to write -- Python provides fewer footguns than C - KMK cut all the "tech debt" of supporting AVR controllers, and frankly even most ARM controllers with under 256KB of flash. This let us make some very user-friendly (in our biased opinions) design decisions that should make it @@ -71,15 +70,14 @@ particular order): Tap Dance implementation has you covered (without a single line of matrix mangling or timer madness) - KMK supports a few small features QMK doesn't - most are probably not - deal-closers, but they exist no less. Probably the most notable addition here - is `Leader Mode - Enter`. Check out `docs/leader.md` for details on that. + deal-closers, but they exist no less.. - KMK plans to support some fairly powerful hardware that would enable things like connecting halves (or thirds, or whatever) of a split keyboard to each other via Bluetooth. This stuff is still in very early R&D. ## So how do I use it? -Since KMK is still in some state between "alpha" and "beta", flashing KMK to a +Since KMK is still in beta currently. Flashing KMK to a board is still a process that requires a few lines of shell scripting. Check out `docs/flashing.md` for instructions/details, though note that for now, the instructions mostly assume Unix (Linux/MacOS/BSD) usage. You may want to check diff --git a/docs/keycodes.md b/docs/keycodes.md index 4d0a7f3..cb77394 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -248,22 +248,20 @@ |`KC.RGB_MODE_KNIGHT` |`RGB_M_K` |Knightrider animation | -## [Mod-Tap Keys] NOT IMPLEMENTED AT THIS TIME +## [Mod-Tap Keys] -|Key |Aliases |Description | -|------------|---------------------------------------|-------------------------------------------------------| -|`LCTL_T(kc)`|`CTL_T(kc)` |Left Control when held, `kc` when tapped | -|`RCTL_T(kc)`| |Right Control when held, `kc` when tapped | -|`LSFT_T(kc)`|`SFT_T(kc)` |Left Shift when held, `kc` when tapped | -|`RSFT_T(kc)`| |Right Shift when held, `kc` when tapped | -|`LALT_T(kc)`|`ALT_T(kc)` |Left Alt when held, `kc` when tapped | -|`RALT_T(kc)`|`ALGR_T(kc)` |Right Alt when held, `kc` when tapped | -|`LGUI_T(kc)`|`LCMD_T(kc)`, `RWIN_T(kc)`, `GUI_T(kc)`|Left GUI when held, `kc` when tapped | -|`RGUI_T(kc)`|`RCMD_T(kc)`, `RWIN_T(kc)` |Right GUI when held, `kc` when tapped | -|`C_S_T(kc)` | |Left Control and Shift when held, `kc` when tapped | -|`MEH_T(kc)` | |Left Control, Shift and Alt when held, `kc` when tapped| -|`LCAG_T(kc)`| |Left Control, Alt and GUI when held, `kc` when tapped | -|`RCAG_T(kc)`| |Right Control, Alt and GUI when held, `kc` when tapped | -|`ALL_T(kc)` | |Left Control, Shift, Alt and GUI when held, `kc` when tapped - more info [here](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)| -|`SGUI_T(kc)`|`SCMD_T(kc)`, `SWIN_T(kc)` |Left Shift and GUI when held, `kc` when tapped | -|`LCA_T(kc)` | |Left Control and Alt when held, `kc` when tapped | +|New Keycode | Description | +|-------------------------------------------------------|-----------------------------------------------------------------| +|LCTL = KC.MT(KC.SOMETHING, KC.LCTRL) |`LCTRL` if held `kc` if tapped | +|LSFT = KC.MT(KC.SOMETHING, KC.LSFT) |`LSHIFT` if held `kc` if tapped | +|LALT = KC.MT(KC.SOMETHING, KC.LALT) |`LALT` if held `kc` if tapped | +|LGUI = KC.MT(KC.SOMETHING, KC.LGUI) |`LGUI` if held `kc` if tapped | +|RCTL = KC.MT(KC.SOMETHING, KC.RCTRL) |`RCTRL` if held `kc` if tapped | +|RSFT = KC.MT(KC.SOMETHING, KC.RSFT) |`RSHIFT` if held `kc` if tapped | +|RALT = KC.MT(KC.SOMETHING, KC.RALT) |`RALT` if held `kc` if tapped | +|RGUI = KC.MT(KC.SOMETHING, KC.RGUI) |`RGUI` if held `kc` if tapped | +|SGUI = KC.MT(KC.SOMETHING, KC.LSHFT(KC.LGUI)) |`LSHIFT` and `LGUI` if held `kc` if tapped | +|LCA = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LALT)) |`LCTRL` and `LALT` if held `kc` if tapped | +|LCAG = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LALT(KC.LGUI))) |`LCTRL` and `LALT` and `LGUI` if held `kc` if tapped | +|MEH = KC.MT(KC.SOMETHING, KC.LCTRL(KC.LSFT(KC.LALT))) |`CTRL` and `LSHIFT` and `LALT` if held `kc` if tapped | +|HYPR = KC.MT(KC.SOMETHING, KC.HYPR) |`LCTRL` and `LSHIFT` and `LALT` and `LGUI` if held `kc` if tapped|