summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorIBNobody <protospherex@gmail.com>2016-10-29 11:13:15 -0500
committerIBNobody <protospherex@gmail.com>2016-10-29 11:13:15 -0500
commite40c33f754a86c4dd7bd3c7b5c7efe822f2893bc (patch)
treebf372a8afead88128f68d373435025a16fbf53c2 /keyboards/ergodox/keymaps/mclennon_osx/README.md
parent973f526bb4928bf3aec6067aa444b31ace997c8a (diff)
parent32f88c07173b795c6981c779057dceba00aeb1cb (diff)
Merge branch 'master' of https://github.com/IBNobody/qmk_firmware
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/).