summaryrefslogtreecommitdiffstats
path: root/docs/mouse_keys.md
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2017-07-07 03:43:22 +0200
committerGitHub <noreply@github.com>2017-07-07 03:43:22 +0200
commitecd3dbf085826459af9728b6529a504ba7d3de14 (patch)
tree7ca3733c63b5f720ae1f0118516dda0984d54fe0 /docs/mouse_keys.md
parent9cadba7b895a81f329a4c2eee253e57c11715b80 (diff)
parent1896c76a2928c96f9ab7947bec2ef8dd37623cff (diff)
downloadqmk_firmware-ecd3dbf085826459af9728b6529a504ba7d3de14.tar.gz
qmk_firmware-ecd3dbf085826459af9728b6529a504ba7d3de14.tar.xz
Merge branch 'master' into docs
Diffstat (limited to 'docs/mouse_keys.md')
-rw-r--r--docs/mouse_keys.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/mouse_keys.md b/docs/mouse_keys.md
index e6dfe7bd9..560bd0470 100644
--- a/docs/mouse_keys.md
+++ b/docs/mouse_keys.md
@@ -1,5 +1,6 @@
# Mousekeys
+
Mousekeys is a feature that allows you to emulate a mouse using your keyboard. You can move the pointer around, click up to 5 buttons, and even scroll in all 4 directions. QMK uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).
## Adding Mousekeys To a Keymap
@@ -54,6 +55,7 @@ The default speed for controlling the mouse with the keyboard is intentionaly sl
#define MOUSEKEY_WHEEL_TIME_TO_MAX 40
```
+
### `MOUSEKEY_DELAY`
When one of the mouse movement buttons is pressed this setting is used to define the delay between that button press and the mouse cursor moving. Some people find that small movements are impossible if this setting is too low, while settings that are too high feel sluggish.
@@ -76,4 +78,4 @@ The top speed for scrolling movements.
### `MOUSEKEY_WHEEL_TIME_TO_MAX`
-How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickling your scrolling will accelerate.
+How long you want to hold down a scroll key for until `MOUSEKEY_WHEEL_MAX_SPEED` is reached. This controls how quickling your scrolling will accelerate. \ No newline at end of file