summaryrefslogtreecommitdiffstats
path: root/docs/macros.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/macros.md
parent9cadba7b895a81f329a4c2eee253e57c11715b80 (diff)
parent1896c76a2928c96f9ab7947bec2ef8dd37623cff (diff)
downloadqmk_firmware-ecd3dbf085826459af9728b6529a504ba7d3de14.tar.gz
qmk_firmware-ecd3dbf085826459af9728b6529a504ba7d3de14.tar.xz
Merge branch 'master' into docs
Diffstat (limited to 'docs/macros.md')
-rw-r--r--docs/macros.md8
1 files changed, 7 insertions, 1 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:
## Sending strings
-Sometimes 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.
+Sometimes 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()`.
For example:
@@ -60,6 +60,12 @@ const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
};
```
+By 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:
+
+```
+#include <sendstring_colemak.h>
+```
+
## Mapping a Macro to a key
Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard: