summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorErez Zukerman2016-02-05 16:28:24 +0200
committerErez Zukerman2016-02-05 16:28:24 +0200
commit3c683aa9f23288ddada760fb49abcc5fa7324f5e (patch)
tree6b8e68c000238bb5d72c1d1c08aec1600fd5caa0 /README.md
parent1b0d0c684872e0a2fbd0d8efaa1a156afee8a028 (diff)
Fixes CM_SCLN and updates docs for Colemak
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9c476e507..e02fba913 100644
--- a/README.md
+++ b/README.md
@@ -138,9 +138,9 @@ Note: Using macros to have your keyboard send passwords for you is a bad idea.
Everything is assuming you're in Qwerty (in software) by default, but there is built-in support for using a Colemak or Dvorak layout by including this at the top of your keymap:
- #include "keymap_<layout>.h"
+ #include <keymap_extras/keymap_colemak.h>
-Where <layout> is "colemak" or "dvorak". After including this line, you will get access to:
+If you use Dvorak, use `keymap_dvorak.h` instead of `keymap_colemak.h` for this line. After including this line, you will get access to:
* `CM_*` for all of the Colemak-equivalent characters
* `DV_*` for all of the Dvorak-equivalent characters