aboutsummaryrefslogtreecommitdiff
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 000000000..3869304f4
--- /dev/null
+++ b/keyboards/planck/keymaps/mitch/readme.md
@@ -0,0 +1,26 @@
1## Flashing Keyboard
2
31. Install `dfu` tools:
4
5 brew tap osx-cross/avr
6 brew install avr-libc
7 brew install dfu-programmer
8
92. Move to this directory.
103. Hit the reset button on the keyboard.
114. run `make dfu`.
12
13## The Keymap
14
15This keymap is designed for a rev3 Planck Keyboard.
16
17The default layer is QWERTY. The raise layer has a ten key on the right
18and common programming punctuation on the left. The lower layer provides the
19rest of the symbols, mostly mapped with the ten key numbers.
20
21The normal right shift key uses the `MT` macro to trigger Enter on tap and right
22shift when held.
23
24This keymap sets the `PREVENT_STUCK_MODIFIERS` flag to avoid the occasional WTF
25moments when using a modifier keys and accidentally releasing them after moving
26to a new layer.