README.md: Update the documentation

Refer to modifiers with their new names, and to Kaleidoscope as such (as opposed
to KaleidoscopeFirmware, a remnant of KeyboardioFirmware, I suppose).

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 8 years ago
parent 5d5d8747eb
commit 6be3cc0010

@ -50,16 +50,16 @@ There are two macros the plugin provides:
### `OSM(mod)` ### `OSM(mod)`
> A macro that takes a single argument, the name of the modifier: `LCtrl`, > A macro that takes a single argument, the name of the modifier: `LeftCtrl`,
> `LShift`, `LAlt`, `LGUI` or their right-side variant. When marked up with this > `LeftShift`, `LeftAlt`, `LeftGUI` or their right-side variant. When marked up
> macro, the modifier will act as a one-shot modifier. > with this macro, the modifier will act as a one-shot modifier.
### `OSL(layer)` ### `OSL(layer)`
> Takes a layer number as argument, and sets up the key to act as a one-shot > Takes a layer number as argument, and sets up the key to act as a one-shot
> layer key. > layer key.
> >
> Please note that while `KaleidoscopeFirmware` supports more, one-shot layers are > Please note that while `Kaleidoscope` supports more, one-shot layers are
> limited to 24 layers only. > limited to 24 layers only.
## Plugin methods ## Plugin methods

Loading…
Cancel
Save