summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorJoshua T <joshua@sonofone.net>2016-10-15 15:14:10 -0500
committerJoshua T <joshua@sonofone.net>2016-10-15 15:14:10 -0500
commit2e6a1a53d73607030c470b88d3ed7223db5e0004 (patch)
treefd8ff310f0dba21f9135cdead49482af2276329b /keyboards/ergodox/keymaps/mclennon_osx/README.md
parent5520b0022fc6cd3dff805eb31ed4bb7e4385ee2a (diff)
parent0a9ad8f335f5b5b9d184d9e5e9ece6cda149df7e (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/ergodox/keymaps/mclennon_osx/README.md')
-rw-r--r--keyboards/ergodox/keymaps/mclennon_osx/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/keyboards/ergodox/keymaps/mclennon_osx/README.md b/keyboards/ergodox/keymaps/mclennon_osx/README.md
new file mode 100644
index 0000000000..60980d043d
--- /dev/null
+++ b/keyboards/ergodox/keymaps/mclennon_osx/README.md
@@ -0,0 +1,5 @@
+# Ergodox EZ for OS X
+
+This keymapping is designed to be reasonably familiar to an ordinary Mac keyboard while taking advantage of the Ergodox EZ's features. Caps lock instead enables a layer which allows a user to use HJKL as arrow keys and to control media. Shift and control have additional mappings on S and D to provide easier access while holding down caps lock.
+
+If you choose to compile this yourself, be sure to compile with `#define PREVENT_STUCK_MODIFIERS` in your `config.h`. Firmware built using [qmk_firmware](https://github.com/jackhumbert/qmk_firmware/).