X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_mouse_keys.md;h=673eafaef5e02aa060681a3df9b58d1eaf00db96;hb=98b16b3294e4b04e6621daba8cff07fbd982f335;hp=dd846e096a653ff6ec330dc8861f4cbd44d31e84;hpb=4c675a83ba1d3561bfd6baad57a250066f5db4d3;p=qmk_firmware.git diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md index dd846e096..673eafaef 100644 --- a/docs/feature_mouse_keys.md +++ b/docs/feature_mouse_keys.md @@ -5,17 +5,17 @@ Mousekeys is a feature that allows you to emulate a mouse using your keyboard. Y ## Adding Mousekeys to a Keymap -There are two steps to adding Mousekeys support to your keyboard. You must enable support in the Makefile and you must map mouse actions to keys on your keyboard. +There are two steps to adding Mousekeys support to your keyboard. You must enable support in the `rules.mk` file and you must map mouse actions to keys on your keyboard. -### Adding Mousekeys Support in the `Makefile` +### Adding Mousekeys Support in the `rules.mk` -To add support for Mousekeys you simply need to add a single line to your keymap's `Makefile`: +To add support for Mousekeys you simply need to add a single line to your keymap's `rules.mk`: ``` MOUSEKEY_ENABLE = yes ``` -You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/Makefile +You can see an example here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/rules.mk ### Mapping Mouse Actions to Keyboard Keys @@ -40,11 +40,11 @@ You can use these keycodes within your keymap to map button presses to mouse act |`KC_MS_ACCEL1` |`KC_ACL1`|Set mouse acceleration to 1| |`KC_MS_ACCEL2` |`KC_ACL2`|Set mouse acceleration to 2| -You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/mouse_keys/keymap.c#L46 +You can see an example in the `_ML` here: https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/66/keymaps/mouse_keys/keymap.c#L46 ## Configuring the Behavior of Mousekeys -The default speed for controlling the mouse with the keyboard is intentionaly slow. You can adjust these parameters by adding these settings to your keymap's `config.h` file. All times are specified in miliseconds (ms). +The default speed for controlling the mouse with the keyboard is intentionally slow. You can adjust these parameters by adding these settings to your keymap's `config.h` file. All times are specified in milliseconds (ms). ``` #define MOUSEKEY_DELAY 300 @@ -78,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 quickly your scrolling will accelerate.