aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/mclennon_osx/README.md
diff options
context:
space:
mode:
authorGravatar Damien <Dbroqua@users.noreply.github.com>2016-09-30 22:55:07 +0200
committerGravatar GitHub <noreply@github.com>2016-09-30 22:55:07 +0200
commit7abd3b4ddd0eb4ae4da6cce9283cfcf8089ac449 (patch)
tree7b92a1e899976a94e1846d8c0b1bd0e1039ca705 /keyboards/ergodox/keymaps/mclennon_osx/README.md
parenteb0f21a984eff2a8c4ad15f91fb18b456373e921 (diff)
parent35e6870e5c8943c044187256e01c96ef400ca067 (diff)
downloadqmk_firmware-7abd3b4ddd0eb4ae4da6cce9283cfcf8089ac449.tar.gz
Merge pull request #7 from jackhumbert/master
Merge from jackhumbert
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/).