summaryrefslogtreecommitdiffstats
path: root/layouts/community/ergodox/mclennon_osx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'layouts/community/ergodox/mclennon_osx/README.md')
-rw-r--r--layouts/community/ergodox/mclennon_osx/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/layouts/community/ergodox/mclennon_osx/README.md b/layouts/community/ergodox/mclennon_osx/README.md
new file mode 100644
index 000000000..28cdb7c10
--- /dev/null
+++ b/layouts/community/ergodox/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/qmk/qmk_firmware/).