summaryrefslogtreecommitdiff
path: root/keyboards/dz60/keymaps/mrsendyyk/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/dz60/keymaps/mrsendyyk/readme.md')
-rw-r--r--keyboards/dz60/keymaps/mrsendyyk/readme.md80
1 files changed, 45 insertions, 35 deletions
diff --git a/keyboards/dz60/keymaps/mrsendyyk/readme.md b/keyboards/dz60/keymaps/mrsendyyk/readme.md
index dc2dfefe0a..f5b74d8ebd 100644
--- a/keyboards/dz60/keymaps/mrsendyyk/readme.md
+++ b/keyboards/dz60/keymaps/mrsendyyk/readme.md
@@ -1,46 +1,56 @@
-# Sendy YK's Keymap
----
+# [Sendy YK](https://mr.sendyyk.com)'s Keymap
+`LAYOUT_60_ansi_arrow` with RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer indicator.
-KBDfans DZ60 ANSI with Arrow also RGB Underglow as a Caps Lock Indicator
+### Default Layer [0]
-### Qwerty [0]
```
-,-----------------------------------------------------------------------------------------.
-| Esc | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | Backspace |
-|-----------------------------------------------------------------------------------------+
-| Tab | Q | W | E | R | T | Y | U | I | O | P | [ | ] | \ |
-|-----------------------------------------------------------------------------------------+
-|Caps Lock| A | S | D | F | G | H | J | K | L | ; | ' | Enter |
-|-----------------------------------------------------------------------------------------+
-| Shift | Z | X | C | V | B | N | M | , | . | RShift | Up | / |
-|-----------------------------------------------------------------------------------------+
-| Ctrl | OS | Alt | Space | RAlt | Fn |Left |Down |Right|
-`-----------------------------------------------------------------------------------------'
+┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+│Esc│1 │2 │3 │4 │5 │6 │7 │8 │9 │0 │- │= │Bspc │
+├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+│Tab │Q │W │E │R │T │Y │U │I │O │P │[ │] │\ │
+├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+│Caps L│A │S │D │F │G │H │J │K │L │; │' │Enter │
+├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
+│Shift │Z │X │C │V │B │N │M │, │. │Shift │↑ │/ │
+├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
+│Ctl │OS │Alt │ Space │Alt│Ctl│← │↓ │→ │
+└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
```
### Fn Layer [1]
+Press and hold *right* **Ctl** key.
```
-,-----------------------------------------------------------------------------------------.
-| ` ~ | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | Delete |
-|-----------------------------------------------------------------------------------------+
-| Bri Up | | | End | Rst | | | | Ins | | P Sc| | | Eject |
-|-----------------------------------------------------------------------------------------+
-| Bri Down| | S L | | | | Home| | | | | | Mute |
-|-----------------------------------------------------------------------------------------+
-| Vol + | | | Calc| | | | Mail| | | |Pg U |Pause|
-|-----------------------------------------------------------------------------------------+
-| Vol - | Rwd | F Fd | Play | M Stp| | Prev| Pg D| Next|
-`-----------------------------------------------------------------------------------------'
+┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+│` │F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│Delete │
+├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+│Bri+ │ │ │End│Rst│ │ │ │Ins│ │P S│ │ │Eject│
+├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+│Bri- │ │S L│ │ │ │Hm │ │ │ │ │ │Mute │
+├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
+│Vol+ │ │ │Cal│ │ │N L│Ml │ │ │Pause │P U│ │
+├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
+│Vol-│Rwd │F FD│ Play │Stp│ │Prv│P D│Nxt│
+└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
```
-### RGB Underglow as a Caps Lock Indicator
-
-Set in `mrsendyyk/keymap.c` in the `led_set_user` function.
-
----
+### Fn Layer [2]
+Press and hold *right* **Alt** key.
+```
+┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
+│ │ │ │ │ │ │ │ │ │ │ │ │ │ │
+├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
+│ │R T│R M│Hu+│Hu-│Sa+│Sa-│Br+│Br-│ │ │ │ │ │
+├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
+│ │ │ │ │ │ │ │ │ │ │ │ │ │
+├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
+│ │ │ │ │BL-│B T│BL+│B C│ │ │ │ │ │
+├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
+│ │ │ │ │ │ │ │ │ │
+└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
+```
-Make example for this keyboard (after setting up your build environment):
+## Build The Firmware
+You will need to build the firmware. To do so go to your terminal window and run the compile command:
- make dz60:mrsendyyk
-
-See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+ qmk compile -kb dz60 -km mrsendyyk
+See [The Complete Newbs Guide To QMK](https://docs.qmk.fm/#/newbs).