summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorErez Zukerman2016-09-30 08:59:24 -0400
committerGitHub2016-09-30 08:59:24 -0400
commitfede822fce82e6350af5d0e599745166040563e6 (patch)
tree3f6b2ebd20eac22d67b250a8a2a98a0cdcba130c /keyboards/ergodox/keymaps/mclennon_osx/README.md
parent7c76d364549f7c27d09134f9a8308e05928ad550 (diff)
parentcce294df86be7c430f8764ae3330991e66138f43 (diff)
Merge pull request #789 from cmclen/master
Contributing new keymap to Ergodox
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/).