alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README to match new hid facade

Browse Source
pull/389/head
Jesse Vincent 8 years ago
parent 061047c52e
commit 33a1fd6c34
No known key found for this signature in database
GPG Key ID: 122F5DF7108E4046
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File

3
README.md
Unescape View File

@ -34,6 +34,7 @@ plugin:
```c++ ```c++
#include <Kaleidoscope.h> #include <Kaleidoscope.h>
#include <Kaleidoscope-OneShot.h> #include <Kaleidoscope-OneShot.h>
#include <kaleidoscope/hid.h>
// somewhere in the keymap... // somewhere in the keymap...
OSM(LeftControl), OSL(_FN) OSM(LeftControl), OSL(_FN)
@ -79,7 +80,7 @@ modifiers and one-shot layer keys. It has the following methods and properties:
### `.isModifierActive(key)` ### `.isModifierActive(key)`
> Returns if the modifier `key` has a one-shot state active. Use this together > Returns if the modifier `key` has a one-shot state active. Use this together
> with `Keyboard.isModifierActive` to catch cases where a one-shot modifier is > with `hid::isModifierKeyActive` to catch cases where a one-shot modifier is
> active, but not registered yet. > active, but not registered yet.
### `.cancel([with_stickies])` ### `.cancel([with_stickies])`

Write Preview
Loading…
Cancel
Save