Minor updates 60_ansi_arrow (#10332)

* Minor updates 60_ansi_arrow * Update keymap.c * Update keymap.c * Minnor updates * Minnor updates * Update readme.md
2020-09-21 13:34:06 -07:00
parent 2f637e4ea1
commit becaf325a3
6 changed files with 285 additions and 331 deletions
@@ -1,50 +1,85 @@
-# [Sendy YK](https://mr.sendyyk.com)'s 60_ansi_arrow Keymap
-`LAYOUT_60_ansi_arrow` with RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer indicator.
+# Sendy YK's 60% ANSI Arrow Layout and Keymap

-### Default Layer [0]
+[https://mr.sendyyk.com](https://mr.sendyyk.com)

-```
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-│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│←  │↓  │→  │
-└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-```
+## 60% ANSI Arrow Layout

-### Fn Layer [1]
-Press and hold *right* **Ctl** key.
-```
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-│`  │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│
-└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
-```
+![LAYOUT_60_ansi_arrow](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/dz60/assets/layout-60-ansi-arrow.png)
+
+## Keymap
+
+### Default Layer
+
+![_BASE](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/dz60/assets/layout-60-ansi-arrow-keymap---layer-0.png)
+
+### Fn Layer 1
+
+Press and hold *right* **Ctrl** key.
+
+![_FN](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/dz60/assets/layout-60-ansi-arrow-keymap---layer-1.png)
+
+### Fn Layer 2

-### Fn Layer [2]
 Press and hold *right* **Alt** key.
+
+![_SETTINGS](https://raw.githubusercontent.com/mrsendyyk/my_qmk/master/dz60/assets/layout-60-ansi-arrow-keymap---layer-2.png)
+
+### RGB Lighting/LED/Underglow as Caps Lock, Num Lock, Scroll Lock, and Layer Indicator
+
+#### Caps Lock Indicator
+
+```c
+    // Caps Lock Indicator
+    if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {
+        writePinLow(B2);
+        rgblight_setrgb(100, 255, 100);
+    }
 ```
-┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐
-│   │   │   │   │   │   │   │   │   │   │   │   │   │       │
-├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤
-│     │R T│R M│Hu+│Hu-│Sa+│Sa-│Br+│Br-│   │   │   │   │     │
-├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤
-│      │   │   │   │   │   │   │   │   │   │   │   │        │
-├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴┬───┬───┤
-│        │   │   │   │BL-│B T│BL+│B C│   │   │      │   │   │
-├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬───┼───┼───┤
-│    │    │    │                        │   │   │   │   │   │
-└────┴────┴────┴────────────────────────┴───┴───┴───┴───┴───┘
+
+#### Num Lock Indicator
+
+```c
+    // Num Lock Indicator
+    if (host_keyboard_led_state().num_lock) {
+        rgblight_setrgb(225, 8, 0);
+    }
 ```
+
+#### Scroll Lock Indicator
+```c
+    // Scroll Lock Indicator
+    if (host_keyboard_led_state().scroll_lock) {
+        rgblight_setrgb(255, 110, 0);
+    }
+```
+
+#### Layer Indicator
+
+```c
+    // Layer Indicator
+    else {          
+        switch (get_highest_layer(layer_state)) {
+            // Fn Layer 1 Indicator
+            case _FN:
+                rgblight_setrgb(100, 255, 100);
+                break;
+            // Fn Layer 2 Indicator
+            case _SETTINGS:
+                rgblight_setrgb(100, 255, 100);
+                break;
+            // Default Layer Indicator
+            case _BASE:
+                rgblight_setrgb(0, 0, 0);
+                break;
+        }
+        update_led();
+    }
+```
+
+## Build The Firmware
+
+You will need to build the firmware. To do so go to your terminal window and run the compile command:
+
+    qmk compile -kb dz60 -km mrsendyyk
+
+See [The Complete Newbs Guide To QMK](https://docs.qmk.fm/#/newbs).