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