summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/mitch/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/planck/keymaps/mitch/readme.md')
-rw-r--r--keyboards/planck/keymaps/mitch/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/mitch/readme.md b/keyboards/planck/keymaps/mitch/readme.md
new file mode 100644
index 0000000000..3869304f44
--- /dev/null
+++ b/keyboards/planck/keymaps/mitch/readme.md
@@ -0,0 +1,26 @@
+## Flashing Keyboard
+
+1. Install `dfu` tools:
+
+ brew tap osx-cross/avr
+ brew install avr-libc
+ brew install dfu-programmer
+
+2. Move to this directory.
+3. Hit the reset button on the keyboard.
+4. run `make dfu`.
+
+## The Keymap
+
+This keymap is designed for a rev3 Planck Keyboard.
+
+The default layer is QWERTY. The raise layer has a ten key on the right
+and common programming punctuation on the left. The lower layer provides the
+rest of the symbols, mostly mapped with the ten key numbers.
+
+The normal right shift key uses the `MT` macro to trigger Enter on tap and right
+shift when held.
+
+This keymap sets the `PREVENT_STUCK_MODIFIERS` flag to avoid the occasional WTF
+moments when using a modifier keys and accidentally releasing them after moving
+to a new layer.