summaryrefslogtreecommitdiff
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorxyverz <xyverz@gmail.com>2016-09-30 23:16:50 -0700
committerxyverz <xyverz@gmail.com>2016-09-30 23:16:50 -0700
commite69e4c1ef2cd553597e10d1ae5b0384d29f2c16f (patch)
tree957641d33f60e75b8fd747da11ed3bca06f0cfab /keyboards/ergodox/keymaps/mclennon_osx/README.md
parente3c3170610561042df3d67f358c15553878a2012 (diff)
parent35e6870e5c8943c044187256e01c96ef400ca067 (diff)
Merge remote-tracking branch 'jackhumbert/master'
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/).