summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorChris McLennon <mclennon@indeed.com>2016-09-28 13:24:29 -0500
committerChris McLennon <mclennon@indeed.com>2016-09-28 13:24:29 -0500
commit65b0eff6d863d458464c35a8571071ad4a519af5 (patch)
treed1696abee7f86c366bddd4a2889f6be7ee5af03b /keyboards/ergodox/keymaps/mclennon_osx/README.md
parent812219e8a0bf5f317c000d3c5247cdb93a6d7fff (diff)
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 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/).