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

Documentation clarification

Browse Source 
Fixes #4.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/365/head
Gergely Nagy 7 years ago
parent 964b6d2d4a
commit 0808057864
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File

9
README.md
Unescape View File

@ -22,9 +22,9 @@ match one's desired behaviour.
## Using the plugin ## Using the plugin
To use the plugin, simply include the header, make sure the `MouseKeys` object To use the plugin, simply include the header in your Sketch, tell the firmware
is properly used, and place mouse keys on your keymap. It is best illustrated to use the `MouseKeys` object, and place mouse keys on your keymap. It is best
with an example: illustrated with an example:
```c++ ```c++
#include <Kaleidoscope.h> #include <Kaleidoscope.h>
@ -52,7 +52,8 @@ The simplest set of keys are the mouse cursor movement keys. These move the
cursor one direction or the other, with speed and acceleration factored in. When cursor one direction or the other, with speed and acceleration factored in. When
a mouse cursor movement key is held down, it will move `.speed` pixels each a mouse cursor movement key is held down, it will move `.speed` pixels each
`.speedDelay` milliseconds without acceleration. But when `.accelSpeed` is `.speedDelay` milliseconds without acceleration. But when `.accelSpeed` is
non-zero (and it is not zero by default), the speed will increase by non-zero (and it is not zero by default,
see [below](#accelspeed-and-acceldelay)), the speed will increase by
`.accelSpeed` every `.accelDelay` milliseconds. Thus, unless configured `.accelSpeed` every `.accelDelay` milliseconds. Thus, unless configured
otherwise, holding a direction will move that way at increasing speed. otherwise, holding a direction will move that way at increasing speed.

Write Preview
Loading…
Cancel
Save