aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2017-07-06 18:43:22 -0700
committerGitHub <noreply@github.com>2017-07-06 18:43:22 -0700
commitecd3dbf085826459af9728b6529a504ba7d3de14 (patch)
tree7ca3733c63b5f720ae1f0118516dda0984d54fe0 /docs
parent9cadba7b895a81f329a4c2eee253e57c11715b80 (diff)
parent1896c76a2928c96f9ab7947bec2ef8dd37623cff (diff)
downloadqmk_firmware-ecd3dbf085826459af9728b6529a504ba7d3de14.tar.gz
qmk_firmware-ecd3dbf085826459af9728b6529a504ba7d3de14.zip
Merge branch 'master' into docs
Diffstat (limited to 'docs')
-rw-r--r--docs/macros.md8
-rw-r--r--docs/mouse_keys.md4
2 files changed, 10 insertions, 2 deletions
diff --git a/docs/macros.md b/docs/macros.md
index 3d5b05b4a..6b128541b 100644
--- a/docs/macros.md
+++ b/docs/macros.md
@@ -43,7 +43,7 @@ A macro can include the following commands:
43 43
44## Sending strings 44## Sending strings
45 45
46Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string for you instead of having to build a `MACRO()`. Right now it assumes a US keymap with a QWERTY layout, so if you are using something else it may not behave as you expect. 46Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string for you instead of having to build a `MACRO()`.
47 47
48For example: 48For example:
49 49
@@ -60,6 +60,12 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
60}; 60};
61``` 61```
62 62
63By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap:
64
65```
66#include <sendstring_colemak.h>
67```
68
63## Mapping a Macro to a key 69## Mapping a Macro to a key
64 70
65Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard: 71Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
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 @@
1# Mousekeys 1# Mousekeys
2 2
3
3Mousekeys 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). 4Mousekeys 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).
4 5
5## Adding Mousekeys To a Keymap 6## Adding Mousekeys To a Keymap
@@ -54,6 +55,7 @@ The default speed for controlling the mouse with the keyboard is intentionaly sl
54#define MOUSEKEY_WHEEL_TIME_TO_MAX 40 55#define MOUSEKEY_WHEEL_TIME_TO_MAX 40
55``` 56```
56 57
58
57### `MOUSEKEY_DELAY` 59### `MOUSEKEY_DELAY`
58 60
59When 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. 61When 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.
76 78
77### `MOUSEKEY_WHEEL_TIME_TO_MAX` 79### `MOUSEKEY_WHEEL_TIME_TO_MAX`
78 80
79How 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. 81How 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