aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorGravatar Olivier <olivier@gid0.org>2016-11-27 23:23:21 +0100
committerGravatar Olivier <olivier@gid0.org>2016-11-27 23:23:21 +0100
commitd6d0b7eadaa568853b21d74057db306a33b7a847 (patch)
treee935179ed0db152f94d31ef187c01a40f0fb42d6 /keyboards/ergodox/keymaps/mclennon_osx/README.md
parent73d2a470eed73a1ba28520343bd1cfc81498d183 (diff)
parent1585fc4b616cb28b8d4a418cd31c8ce0dd64f731 (diff)
downloadqmk_firmware-d6d0b7eadaa568853b21d74057db306a33b7a847.tar.gz
Merge https://github.com/jackhumbert/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 000000000..60980d043
--- /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/).