Add VIA keymap for Zinc (#9299)

* Add VIA keymap

* Update Document files

Update readme of VIA keymaps

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/rules.mk

* Update keyboards/zinc/keymaps/via/rules.mk

* Update keyboards/zinc/keymaps/via/rules.mk

* Update keyboards/zinc/keymaps/via/rules.mk

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Update keyboards/zinc/keymaps/via/keymap.c

* Add copyright license header

keyboards/zinc/keymaps/via/config.h

@@ -0,0 +1,41 @@
+/*
+This is the c configuration file for the keymap
+
+Copyright 2018 monksoffunk
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#define DYNAMIC_KEYMAP_LAYER_COUNT 5
+
+#define RGBLIGHT_LAYERS
+
+//  place overrides here
+//  Selection of RGBLIGHT MODE to use.
+#if defined(LED_ANIMATIONS)
+    #define RGBLIGHT_ANIMATIONS
+//    #define RGBLIGHT_EFFECT_BREATHINGtt
+//    #define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//    #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//    #define RGBLIGHT_EFFECT_SNAKE
+//    #define RGBLIGHT_EFFECT_KNIGHT
+//    #define RGBLIGHT_EFFECT_CHRISTMAS
+//    #define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//    #define RGBLIGHT_EFFECT_RGB_TEST
+//    #define RGBLIGHT_EFFECT_ALTERNATING
+#endif

keyboards/zinc/keymaps/via/keymap.c

@@ -0,0 +1,203 @@
+/* Copyright 2020 monksoffunk
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include QMK_KEYBOARD_H
+
+#ifdef RGBLIGHT_ENABLE
+//Following line allows macro to read current RGB settings
+
+// Light LEDs 6 to 9 and 12 to 15 red when caps lock is active. Hard to ignore!
+const rgblight_segment_t PROGMEM capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+	{12, 1, HSV_RED}       // Light 4 LEDs, starting with LED 6
+);
+// Light LEDs 9 & 10 in cyan when keyboard layer 1 is active
+const rgblight_segment_t PROGMEM lower_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {24, 6, HSV_GOLDENROD}
+);
+// Light LEDs 11 & 12 in purple when keyboard layer 2 is active
+const rgblight_segment_t PROGMEM raise_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {54, 6, HSV_GOLDENROD}
+);
+
+// Now define the array of layers. Later layers take precedence
+const rgblight_segment_t* const PROGMEM rgb_layers[] = RGBLIGHT_LAYERS_LIST(
+    capslock_layer,
+	lower_layer,
+	raise_layer
+);
+
+void keyboard_post_init_user(void) {
+	// Enable the LED layers
+	rgblight_layers = rgb_layers;
+}
+#endif
+
+extern uint8_t is_master;
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+enum layer_number {
+    _QWERTY = 0,
+    _LOWER,
+    _RAISE,
+    _ADJUST,
+    _ADJUST2
+};
+
+enum custom_keycodes {
+    QWERTY = SAFE_RANGE,
+    KANA,
+    EISU,
+    ADJUST,
+    RGBRST
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* Qwerty
+   * ,-----------------------------------------.             ,-----------------------------------------.
+   * | Tab  |   Q  |   W  |   E  |   R  |   T  |             |   Y  |   U  |   I  |   O  |   P  | Bksp |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * | Ctrl |   A  |   S  |   D  |   F  |   G  |             |   H  |   J  |   K  |   L  |   ;  |  '   |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * | Shift|   Z  |   X  |   C  |   V  |   B  |             |   N  |   M  |   ,  |   .  |   /  |Enter |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * | Esc  |ADJUST| Win  | Alt  |LOWER |Space |             | Space| RAISE| Left | Down |  Up  | Right|
+   * `-----------------------------------------'             `-----------------------------------------'
+   */
+    [_QWERTY] = LAYOUT_ortho_4x12(
+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,                      KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_BSPC,
+        KC_LCTL, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,                      KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
+        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,                      KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT ,
+        KC_ESC,  MO(_ADJUST),  KC_LGUI, KC_LALT, MO(_LOWER),   KC_SPC,               KC_SPC,  MO(_RAISE),   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
+        ),
+
+  /* Lower
+   * ,-----------------------------------------.             ,-----------------------------------------.
+   * |   ~  |   !  |   @  |   #  |   $  |   %  |             |   ^  |   &  |   *  |   (  |   )  |      |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |      |      |      |      |      |             |   -  |   _  |   +  |   {  |   }  |  |   |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |      |      |      |      |      |             |      |      |      | Home | End  |      |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
+   * `-----------------------------------------'             `-----------------------------------------'
+   */
+    [_LOWER] = LAYOUT_ortho_4x12(
+        KC_TILD, KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC,                   KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, _______,
+        _______, _______, _______, _______, _______, _______,                   KC_MINS, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE,
+        _______, _______, _______, _______, _______, _______,                   _______, _______, _______, KC_HOME, KC_END,  _______,
+        _______, _______, _______, _______, _______, _______,                   _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
+        ),
+
+  /* Raise
+   * ,-----------------------------------------.             ,-----------------------------------------.
+   * |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |  F1  |  F2  |  F3  |  F4  |  F5  |             |  F6  |   -  |   =  |   [  |   ]  |  \   |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |  F7  |  F8  |  F9  |  F10 |  F11 |             |  F12 |      |      |      |      |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
+   * `-----------------------------------------'             `-----------------------------------------'
+   */
+    [_RAISE] = LAYOUT_ortho_4x12(
+        KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,                      KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL,
+        _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,                     KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, KC_BSLS,
+        _______, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,                    KC_F12,  _______, _______, _______, _______, _______,
+        _______, _______, _______, _______, _______, _______,                   _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
+        ),
+
+  /* Adjust (Lower + Raise)
+   * ,-----------------------------------------.             ,-----------------------------------------.
+   * |      | Reset|RGBRST|Aud on|Audoff|      |             |      |Qwerty|Colemk|Dvorak|      | Ins  |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |RGB ON| HUE+ | SAT+ | VAL+ | Mac  |             | Win  |  -   |   =  |Print |ScLock|Pause |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |MODE R| MODE | HUE- | SAT- | VAL- |      |             |      |      |      |      |PageUp|      |
+   * |------+------+------+------+------+------|             |------+------+------+------+------+------|
+   * |      |      |      | EISU | EISU | EISU |             | KANA | KANA | Home |PageDn|PageUp| End  |
+   * `-----------------------------------------'             `-----------------------------------------'
+   */
+    [_ADJUST] =  LAYOUT_ortho_4x12(
+        _______, RESET,   RGBRST,  _______, _______, _______,                   _______, QWERTY,  _______, _______,  _______, KC_INS,
+        _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, AG_NORM,                   AG_SWAP, KC_MINS, KC_EQL,  KC_PSCR, KC_SLCK, KC_PAUS,
+        RGB_RMOD,RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______,                   _______, _______, _______, _______, KC_PGUP, _______,
+        _______, _______, _______, EISU,    EISU,    EISU,                      KANA,    KANA,    KANA,    KC_HOME, KC_PGDN, KC_END
+        ),
+
+    [_ADJUST2] =  LAYOUT_ortho_4x12(
+        _______, RESET,   RGBRST,  _______, _______, _______,                   _______, QWERTY,  _______, _______,  _______, KC_INS,
+        _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, AG_NORM,                   AG_SWAP, KC_MINS, KC_EQL,  KC_PSCR, KC_SLCK, KC_PAUS,
+        RGB_RMOD,RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______,                   _______, _______, _______, _______, KC_PGUP, _______,
+        _______, _______, _______, EISU,    EISU,    EISU,                      KANA,    KANA,    KANA,    KC_HOME, KC_PGDN, KC_END
+        )
+};
+
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case EISU:
+            if (record->event.pressed) {
+                if(keymap_config.swap_lalt_lgui==false){
+                    register_code(KC_LANG2);
+                } else {
+                    SEND_STRING(SS_LALT("`"));
+                }
+            } else {
+                unregister_code(KC_LANG2);
+            }
+            return false;
+        case KANA:
+            if (record->event.pressed) {
+                if(keymap_config.swap_lalt_lgui==false){
+                    register_code(KC_LANG1);
+                } else {
+                    SEND_STRING(SS_LALT("`"));
+                }
+            } else {
+                unregister_code(KC_LANG1);
+            }
+            return false;
+        case RGBRST:
+#ifdef RGBLIGHT_ENABLE
+            if (record->event.pressed) {
+                eeconfig_update_rgblight_default();
+                rgblight_enable();
+            }
+#endif
+            break;
+    }
+    return true;
+}
+
+
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+    state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST2);
+#ifdef RGBLIGHT_LAYERS
+    // Both layers will light up if both kb layers are active
+    rgblight_set_layer_state(1, layer_state_cmp(state, 1));
+    rgblight_set_layer_state(2, layer_state_cmp(state, 2));
+#endif
+    return state;
+}
+
+bool led_update_user(led_t led_state) {
+    rgblight_set_layer_state(0, led_state.caps_lock);
+    return true;
+}

keyboards/zinc/keymaps/via/readme_en.md

@@ -0,0 +1,115 @@
+# The VIA Zinc Layout
+## layout
+
+### Qwerty
+
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ | Tab  |   Q  |   W  |   E  |   R  |   T  |             |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ | Ctrl |   A  |   S  |   D  |   F  |   G  |             |   H  |   J  |   K  |   L  |   ;  |  '   |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ | Shift|   Z  |   X  |   C  |   V  |   B  |             |   N  |   M  |   ,  |   .  |   /  |Enter |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ | Esc  |  Fn  | Alt  | Win  |Lower |Space |             | Space| Raise| Left | Down |  Up  | Right|
+ `------------------------------------------             ------------------------------------------'
+```
+
+### Lower
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |   ~  |   !  |   @  |   #  |   $  |   %  |             |   ^  |   &  |   *  |   (  |   )  |      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |   -  |   _  |   +  |   {  |   }  |  |   |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |      |      |      | Home | End  |      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+
+### RAISE
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |  F1  |  F2  |  F3  |  F4  |  F5  |             |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |  F7  |  F8  |  F9  |  F10 |  F11 |             |  F12 |      |      |      |      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+
+### Adjust
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |      | Reset|RGBRST|Aud on|Audoff|      |             |      |Qwerty|Colemk|Dvorak|      | Ins  |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |RGB ON| HUE+ | SAT+ | VAL+ | Mac  |             | Win  |  -   |   =  |Print |ScLock|Pause |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |MODE R|RGBMOD| HUE- | SAT- | VAL- |      |             |      |      |      |      |PageUp|      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      | EISU | EISU | EISU |             | KANA | KANA | KANA | Home |PageDn| End  |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+
+### Adjust2 (Lower + Raise)
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |      | Reset|RGBRST|Aud on|Audoff|      |             |      |Qwerty|Colemk|Dvorak|      | Ins  |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |RGB ON| HUE+ | SAT+ | VAL+ | Mac  |             | Win  |  -   |   =  |Print |ScLock|Pause |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |MODE R|RGBMOD| HUE- | SAT- | VAL- |      |             |      |      |      |      |PageUp|      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      | EISU | EISU | EISU |             | KANA | KANA | KANA | Home |PageDn| End  |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+## Compile
+
+go to qmk top directory.
+
+```
+$ cd qmk_firmware
+```
+make with `zinc:<keymap_name>`
+
+```
+$ make zinc:default
+```
+
+To make and flash with `:flash`
+
+```
+$ make zinc:default:flash
+```
+
+
+## Customize
+
+You can customize from the command line.
+
+```
+# Zinc keyboard 'default' keymap: convenient command line option
+make ZINC=<options> zinc:defualt
+#    option= back | under | both | cont | na | ios
+#    ex.
+#      make ZINC=under    zinc:via 
+#      make ZINC=under,ios zinc:via
+#      make ZINC=back     zinc:via
+#      make ZINC=back,na  zinc:via
+#      make zinc:via
+```
+
+Or edit `qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` directly.
+
+```
+# Zinc keyboard customize
+LED_BACK_ENABLE = no        # LED backlight (Enable SK6812mini backlight)
+LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight)
+LED_BOTH_ENABLE = no        # LED backlight and underglow
+LED_RGB_CONT = no           # LED continuous backlight or/and underglow between left Zinc and right Zinc
+LED_ANIMATIONS = yes        # LED animations
+IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
+```

keyboards/zinc/keymaps/via/readme_jp.md

@@ -0,0 +1,149 @@
+# The VIA Zinc Layout
+## 配列
+
+### Qwerty配列
+
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ | Tab  |   Q  |   W  |   E  |   R  |   T  |             |   Y  |   U  |   I  |   O  |   P  | Bksp |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ | Ctrl |   A  |   S  |   D  |   F  |   G  |             |   H  |   J  |   K  |   L  |   ;  |  '   |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ | Shift|   Z  |   X  |   C  |   V  |   B  |             |   N  |   M  |   ,  |   .  |   /  |Enter |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ | Esc  |  Fn  | Alt  | Win  |Lower |Space |             | Space| Raise| Left | Down |  Up  | Right|
+ `------------------------------------------             ------------------------------------------'
+```
+
+ ### Lower
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |   ~  |   !  |   @  |   #  |   $  |   %  |             |   ^  |   &  |   *  |   (  |   )  |      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |   -  |   _  |   +  |   {  |   }  |  |   |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |      |      |      | Home | End  |      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+
+### RAISE
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |   `  |   1  |   2  |   3  |   4  |   5  |             |   6  |   7  |   8  |   9  |   0  | Del  |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |  F1  |  F2  |  F3  |  F4  |  F5  |             |  F6  |   -  |   =  |   [  |   ]  |  \   |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |  F7  |  F8  |  F9  |  F10 |  F11 |             |  F12 |      |      |      |      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      |      |      |      |             |      |      | Next | Vol- | Vol+ | Play |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+
+### Adjust
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |      | Reset|RGBRST|Aud on|Audoff|      |             |      |Qwerty|Colemk|Dvorak|      | Ins  |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |RGB ON| HUE+ | SAT+ | VAL+ | Mac  |             | Win  |  -   |   =  |Print |ScLock|Pause |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |MODE R|RGBMOD| HUE- | SAT- | VAL- |      |             |      |      |      |      |PageUp|      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      | EISU | EISU | EISU |             | KANA | KANA | KANA | Home |PageDn| End  |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+
+### Adjust2 (Lower + Raise)
+```
+ ,-----------------------------------------.             ,-----------------------------------------.
+ |      | Reset|RGBRST|Aud on|Audoff|      |             |      |Qwerty|Colemk|Dvorak|      | Ins  |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |RGB ON| HUE+ | SAT+ | VAL+ | Mac  |             | Win  |  -   |   =  |Print |ScLock|Pause |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |MODE R|RGBMOD| HUE- | SAT- | VAL- |      |             |      |      |      |      |PageUp|      |
+ |------+------+------+------+------+------|             |------+------+------+------+------+------|
+ |      |      |      | EISU | EISU | EISU |             | KANA | KANA | KANA | Home |PageDn| End  |
+ `-----------------------------------------'             `-----------------------------------------'
+```
+※AdjustとAdjust2は同じものが入っています。このデータの冗長化は、VIA Configuratorでの変更を容易にするために実装を単純化する必要があったためです。Adjust2はLowerとRaiseの同時押しの際に有効になるレイヤーです
+
+
+## コンパイルの仕方
+
+コンパイルは、qmk_firmware のトップディレクトリで行います。
+
+```
+$ cd qmk_firmware
+```
+qmk_firmwareでは各キーボードのコンパイルは、`<キーボード名>:<キーマップ名>`という指定で行います。
+
+```
+$ make zinc:via
+```
+
+キーボードへの書き込みまで同時に行うには下記のように`:avrdude`を付けます。
+
+```
+$ make zinc:via:avrdude
+```
+
+コンパイル結果と中間生成物を消去したい場合は以下のようにします。
+
+```
+$ make zinc:via:clean
+```
+
+## カスタマイズ
+
+コマンドラインからオプションを指定してビルドすることが出来ます。
+ただしVIAキーマップではオプションなしでbothが指定されますので、ほとんどの場合はオプション記述なしでmake zinc:viaとします。
+
+```
+# Zinc keyboard 'via' keymap: convenient command line option
+make ZINC=<options> zinc:via
+#    option= back | under | both | cont | na | ios
+#    ex.
+#      make ZINC=under    zinc:via
+#      make ZINC=under,ios zinc:via
+#      make ZINC=back     zinc:via
+#      make ZINC=back,na  zinc:via
+#      make zinc:via
+```
+
+あるいは`qmk_firmware/keyboards/zinc/rev1/keymaps/~/rules.mk` の以下の部分を直接編集して機能を有効化してください。
+
+```
+# Zinc keyboard customize
+LED_BACK_ENABLE = no        # LED backlight (Enable SK6812mini backlight)
+LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight)
+LED_BOTH_ENABLE = yes       # LED backlight and underglow
+LED_RGB_CONT = yes           # LED continuous backlight or/and underglow between left Zinc and right Zinc
+LED_ANIMATIONS = yes        # LED animations
+IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
+```
+
+## RGB backlight を有効にする
+
+rules.mk の下記の部分を編集して no を yes に変更してください。
+```
+LED_BACK_ENABLE = yes   # LED backlight (Enable SK6812mini backlight)
+```
+※VIAキーマップではオプションなしでbothが指定されます
+
+## RGB Underglow を有効にする
+
+rules.mk の下記の部分を編集して no を yes に変更してください。
+```
+LED_UNDERGLOW_ENABLE = yes   # LED underglow (Enable WS2812 RGB underlight.)
+```
+※VIAキーマップではオプションなしでbothが指定されます
+
+## iPad/iPhoneサポートを有効にする。
+
+rules.mk の下記の部分を編集して no を yes に変更してください。
+RBG Underglow や RGBバックライトの輝度を抑えて、iPad, iPhone にも接続できるようになります。
+
+```
+IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
+```

keyboards/zinc/keymaps/via/rules.mk

@@ -0,0 +1,113 @@
+VIA_ENABLE = yes
+EXTRAKEY_ENABLE = yes
+
+define ZINC_CUSTOMISE_MSG
+  $(info Zinc customize)
+  $(info -  LED_BACK_ENABLE=$(LED_BACK_ENABLE))
+  $(info -  LED_UNDERGLOW_ENABLE=$(LED_UNDERGLOW_ENABLE))
+  $(info -  LED_BOTH_ENABLE=$(LED_BOTH_ENABLE))
+  $(info -  LED_RGB_CONT=$(LED_RGB_CONT))
+  $(info -  RGB_MATRIX=$(RGB_MATRIX))
+  $(info -  LED_ANIMATION=$(LED_ANIMATIONS))
+  $(info -  IOS_DEVICE_ENABLE=$(IOS_DEVICE_ENABLE))
+endef
+
+# Zinc keyboard customize
+LED_BACK_ENABLE = no        # LED backlight (Enable SK6812mini backlight)
+LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight)
+LED_BOTH_ENABLE = yes        # LED backlight and underglow
+LED_RGB_CONT = yes           # LED continuous backlight or/and underglow between left Zinc and right Zinc
+RGB_MATRIX = no             # RGB LED Matrix
+RGB_MATRIX_SPLIT_RIGHT = no # RGB Matrix for RIGHT Hand
+LED_ANIMATIONS = yes        # LED animations
+IOS_DEVICE_ENABLE = no      # connect to IOS device (iPad,iPhone)
+LTO_ENABLE = no # if firmware size over limit, try this option
+
+####  LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE.
+####    Do not enable these with audio at the same time.
+
+### Zinc keyboard 'default' keymap: convenient command line option
+##    make ZINC=<options> zinc:defualt
+##    option= back | under | both | cont | matrix | na | ios
+##    ex.
+##      make ZINC=under    zinc:defualt
+##      make ZINC=under,ios zinc:defualt
+##      make ZINC=back     zinc:default
+##      make ZINC=back,na  zinc:default
+##      make ZINC=back,ios zinc:default
+
+ifneq ($(strip $(ZINC)),)
+  ifeq ($(findstring back,$(ZINC)), back)
+    LED_BACK_ENABLE = yes
+  endif
+  ifeq ($(findstring under,$(ZINC)), under)
+    LED_UNDERGLOW_ENABLE = yes
+  endif
+  ifeq ($(findstring both,$(ZINC)), both)
+    LED_BOTH_ENABLE = yes
+  endif
+  ifeq ($(findstring cont,$(ZINC)), cont)
+    LED_RGB_CONT = yes
+  endif
+  ifeq ($(findstring matrix,$(ZINC)), matrix)
+    RGB_MATRIX = yes
+  endif
+  ifeq ($(findstring right,$(ZINC)), right)
+    RGB_MATRIX_SPLIT_RIGHT = yes
+  endif
+  ifeq ($(findstring na,$(ZINC)), na)
+    LED_ANIMATIONS = no
+  endif
+  ifeq ($(findstring ios,$(ZINC)), ios)
+    IOS_DEVICE_ENABLE = yes
+  endif
+  $(eval $(call ZINC_CUSTOMISE_MSG))
+  $(info )
+endif
+
+ifeq ($(strip $(LED_BACK_ENABLE)), yes)
+  RGBLIGHT_ENABLE = yes
+  ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
+    OPT_DEFS += -DRGBLED_BOTH
+    $(info LED_BOTH_ENABLE option is enabled instead of LED_BACK_ENABLE and LED_UNDERGLOW_ENABLE)
+  else
+    OPT_DEFS += -DRGBLED_BACK
+  endif
+else ifeq ($(strip $(LED_UNDERGLOW_ENABLE)), yes)
+  RGBLIGHT_ENABLE = yes
+else
+  RGBLIGHT_ENABLE = no
+endif
+
+ifeq ($(strip $(LED_BOTH_ENABLE)), yes)
+  RGBLIGHT_ENABLE = yes
+  OPT_DEFS += -DRGBLED_BOTH
+endif
+
+ifeq ($(strip $(LED_RGB_CONT)), yes)
+  OPT_DEFS += -DRGBLED_CONT
+endif
+
+ifeq ($(strip $(RGB_MATRIX)), yes)
+  RGBLIGHT_ENABLE = no
+  RGB_MATRIX_ENABLE = WS2812
+endif
+
+ifeq ($(strip $(IOS_DEVICE_ENABLE)), yes)
+  OPT_DEFS += -DIOS_DEVICE_ENABLE
+endif
+
+ifeq ($(strip $(LED_ANIMATIONS)), yes)
+# OPT_DEFS += -DRGBLIGHT_ANIMATIONS
+  OPT_DEFS += -DLED_ANIMATIONS
+
+endif
+
+ifeq ($(strip $(RGB_MATRIX_SPLIT_RIGHT)), yes)
+    OPT_DEFS += -DRGB_MATRIX_SPLIT_RIGHT
+endif
+
+# Uncomment these for debugging
+# $(info -- RGBLIGHT_ENABLE=$(RGBLIGHT_ENABLE))
+# $(info -- OPT_DEFS=$(OPT_DEFS))
+# $(info )