From 65fe8b64f987c764d0b55fdbccce6e1c6726bd97 Mon Sep 17 00:00:00 2001 From: Mark Skipper Date: Sat, 30 Jun 2018 20:49:50 +0100 Subject: [PATCH] Add qukeys docs removed from qukeys readme the link to qukeys readme was broken; the relevant section removed by a [recent commit](https://github.com/keyboardio/Kaleidoscope-DualUse/commit/fe752f474fa54d6b5ebc1f14361ceca40c7a5f82#diff-04c6e90faac2675aa89e2176d2eec7d8). --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ae182c68..fba93073 100644 --- a/README.md +++ b/README.md @@ -57,12 +57,49 @@ likely to generate errors and out-of-order events. ### DualUse key definitions In addition to normal `Qukeys` described above, Kaleidoscope-Qukeys also treats -DualUse keys in the keymap as `Qukeys`. See [the Kaleidoscope-DualUse -documentation](https://github.com/keyboardio/Kaleidoscope-DualUse#keymap-markup) -for a thorough description of how to define DualUse keys. This makes `Qukeys` a -drop-in replacement for the `DualUse` plugin, without the need to edit the -keymap. - +DualUse keys in the keymap as `Qukeys`. This makes `Qukeys` a drop-in replacement +for the `DualUse` plugin, without the need to edit the keymap. + + +The plugin provides a number of macros one can use in keymap definitions: + +#### `CTL_T(key)` + +> A key that acts as the *left* `Control` when held, or used in conjunction with +> other keys, but as `key` when tapped in isolation. The `key` argument must be +> a plain old key, and can't have any modifiers or anything else applied. + +#### `ALT_T(key)` + +> A key that acts as the *left* `Alt` when held, or used in conjunction with +> other keys, but as `key` when tapped in isolation. The `key` argument must be +> a plain old key, and can't have any modifiers or anything else applied. + +#### `SFT_T(key)` + +> A key that acts as the *left* `Shift` when held, or used in conjunction with +> other keys, but as `key` when tapped in isolation. The `key` argument must be +> a plain old key, and can't have any modifiers or anything else applied. + +#### `GUI_T(key)` + +> A key that acts as the *left* `GUI` when held, or used in conjunction with +> other keys, but as `key` when tapped in isolation. The `key` argument must be +> a plain old key, and can't have any modifiers or anything else applied. + +#### `MT(mod, key)` + +> A key that acts as `mod` when held, or used in conjunction with other keys, +> but as `key` when tapped in isolation. The `key` argument must be a plain old +> key, and can't have any modifiers or anything else applied. The `mod` argument +> can be any of the modifiers, *left* or *right* alike. + +#### `LT(layer, key)` + +> A key that momentarily switches to `layer` when held, or used in conjunction +> with other keys, but as `key` when tapped in isolation. The `key` argument +> must be a plain old key, and can't have any modifiers or anything else +> applied. ## Design & Implementation