[Keyboard] Add Quarkeys Z67 with solder and hotswap versions (qmk#19465)

Co-authored-by: Joel Challis <[email protected]> Co-authored-by: jack <[email protected]> Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Ryan <[email protected]>
tacahiroy · Feb 7, 2023 · d83cb27 · d83cb27
1 parent 6095284
commit d83cb27
Show file tree

Hide file tree

Showing 17 changed files with 644 additions and 0 deletions.
diff --git a/keyboards/quarkeys/z67/hotswap/config.h b/keyboards/quarkeys/z67/hotswap/config.h
@@ -0,0 +1,45 @@
+/* 
+/ Copyright 2022 quarkeys
+/ 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:https://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+#include "config_common.h"
+
+#define DIODE_DIRECTION COL2ROW
+
+#define MATRIX_ROW_PINS { B0, B1, B2, B3, F7 }
+#define MATRIX_COL_PINS { C7, F6, F5, F4, F1, B7, D5, D1, D2, D3, D4, D0, D6, D7, B4 }
+
+#define DEBOUNCE 5
+
+#define RGB_DI_PIN F0
+#define RGBLED_NUM 77
+#define RGBLIGHT_HUE_STEP 8
+#define RGBLIGHT_SAT_STEP 8
+#define RGBLIGHT_VAL_STEP 8
+#define RGBLIGHT_LIMIT_VAL 180
+
+#define RGBLIGHT_EFFECT_BREATHING
+#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
+#define RGBLIGHT_DEFAULT_MODE (RGBLIGHT_MODE_RAINBOW_SWIRL + 2)
+
+#define RGBLIGHT_LAYERS
+#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF
+#define RGBLIGHT_SLEEP
diff --git a/keyboards/quarkeys/z67/hotswap/hotswap.c b/keyboards/quarkeys/z67/hotswap/hotswap.c
@@ -0,0 +1,15 @@
+/* 
+/ Copyright 2022 quarkeys
+/ 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:https://www.gnu.org/licenses/>.
+*/
+
+#include "hotswap.h"
diff --git a/keyboards/quarkeys/z67/hotswap/hotswap.h b/keyboards/quarkeys/z67/hotswap/hotswap.h
@@ -0,0 +1,32 @@
+/* 
+/ Copyright 2022 quarkeys
+/ 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:https://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+#include "quantum.h"
+#define XXXX KC_NO
+
+#define LAYOUT( \
+ K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, \
+ K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, \
+ K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K213, K214, \
+ K300, K302, K303, K304, K305, K306, K307, K308, K309, K310, K311, K312, K313, K314, \
+ K400, K401, K403, K406, K410, K411, K412, K413, K414 \
+) { \
+ { K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014 }, \
+ { K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114 }, \
+ { K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, KC_NO, K213, K214 }, \
+ { K300, KC_NO, K302, K303, K304, K305, K306, K307, K308, K309, K310, K311, K312, K313, K314 }, \
+ { K400, K401, KC_NO, K403, KC_NO, KC_NO, K406, KC_NO, KC_NO, KC_NO, K410, K411, K412, K413, K414 } \
+}
+
diff --git a/keyboards/quarkeys/z67/hotswap/info.json b/keyboards/quarkeys/z67/hotswap/info.json
@@ -0,0 +1,90 @@
+{
+ "keyboard_name": "Z67 Hotswap", 
+ "manufacturer": "Quarkeys Stuidio",
+ "url": "www.quarkeys.com", 
+ "maintainer": "TommyZ", 
+ "usb": {
+ "vid": "0x8490",
+ "pid": "0x4102",
+ "device_version": "0.0.1"
+ },
+ "processor": "atmega32u4",
+ "bootloader": "atmel-dfu",
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"label":"Esc", "x":0, "y":0}, 
+ {"label":"!", "x":1, "y":0}, 
+ {"label":"@", "x":2, "y":0}, 
+ {"label":"#", "x":3, "y":0}, 
+ {"label":"$", "x":4, "y":0}, 
+ {"label":"%", "x":5, "y":0}, 
+ {"label":"^", "x":6, "y":0}, 
+ {"label":"&", "x":7, "y":0}, 
+ {"label":"*", "x":8, "y":0}, 
+ {"label":"(", "x":9, "y":0}, 
+ {"label":")", "x":10, "y":0}, 
+ {"label":"_", "x":11, "y":0}, 
+ {"label":"+", "x":12, "y":0}, 
+ {"label":"Backspace", "x":13, "y":0, "w":2}, 
+ {"label":"Delete", "x":15, "y":0}, 
+
+ {"label":"Tab", "x":0, "y":1, "w":1.5}, 
+ {"label":"Q", "x":1.5, "y":1}, 
+ {"label":"W", "x":2.5, "y":1}, 
+ {"label":"E", "x":3.5, "y":1}, 
+ {"label":"R", "x":4.5, "y":1}, 
+ {"label":"T", "x":5.5, "y":1}, 
+ {"label":"Y", "x":6.5, "y":1}, 
+ {"label":"U", "x":7.5, "y":1}, 
+ {"label":"I", "x":8.5, "y":1}, 
+ {"label":"O", "x":9.5, "y":1}, 
+ {"label":"P", "x":10.5, "y":1}, 
+ {"label":"{", "x":11.5, "y":1}, 
+ {"label":"}", "x":12.5, "y":1}, 
+ {"label":"|", "x":13.5, "y":1, "w":1.5}, 
+ {"label":"PgUp", "x":15, "y":1}, 
+
+ {"label":"Caps Lock", "x":0, "y":2, "w":1.75}, 
+ {"label":"A", "x":1.75, "y":2}, 
+ {"label":"S", "x":2.75, "y":2}, 
+ {"label":"D", "x":3.75, "y":2}, 
+ {"label":"F", "x":4.75, "y":2}, 
+ {"label":"G", "x":5.75, "y":2}, 
+ {"label":"H", "x":6.75, "y":2}, 
+ {"label":"J", "x":7.75, "y":2}, 
+ {"label":"K", "x":8.75, "y":2}, 
+ {"label":"L", "x":9.75, "y":2}, 
+ {"label":":", "x":10.75, "y":2}, 
+ {"label":"\"", "x":11.75, "y":2}, 
+ {"label":"Enter", "x":12.75, "y":2, "w":2.25}, 
+ {"label":"PgDn", "x":15, "y":2}, 
+
+ {"label":"Shift", "x":0, "y":3, "w":2.25}, 
+ {"label":"Z", "x":2.25, "y":3}, 
+ {"label":"X", "x":3.25, "y":3}, 
+ {"label":"C", "x":4.25, "y":3}, 
+ {"label":"V", "x":5.25, "y":3}, 
+ {"label":"B", "x":6.25, "y":3}, 
+ {"label":"N", "x":7.25, "y":3}, 
+ {"label":"M", "x":8.25, "y":3}, 
+ {"label":"<", "x":9.25, "y":3}, 
+ {"label":">", "x":10.25, "y":3}, 
+ {"label":"?", "x":11.25, "y":3}, 
+ {"label":"Shift", "x":12.25, "y":3, "w":1.75}, 
+ {"label":"\u2191", "x":14, "y":3}, 
+ {"label":"Fn", "x":15, "y":3}, 
+
+ {"label":"Ctrl", "x":0, "y":4, "w":1.25}, 
+ {"label":"Win", "x":1.25, "y":4, "w":1.25}, 
+ {"label":"Alt", "x":2.5, "y":4, "w":1.25}, 
+ {"x":3.75, "y":4, "w":6.25}, 
+ {"label":"Alt", "x":10, "y":4, "w":1.25}, 
+ {"label":"Ctrl", "x":11.25, "y":4, "w":1.25}, 
+ {"label":"\u2190", "x":13, "y":4}, 
+ {"label":"\u2193", "x":14, "y":4}, 
+ {"label":"\u2192", "x":15, "y":4}
+ ]
+ }
+ }
+}
diff --git a/keyboards/quarkeys/z67/hotswap/keymaps/default/keymap.c b/keyboards/quarkeys/z67/hotswap/keymaps/default/keymap.c
@@ -0,0 +1,85 @@
+/* 
+/ Copyright 2022 quarkeys
+/ 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:https://www.gnu.org/licenses/>.
+*/
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+ /* [0]
+ * ,---------------------------------------------------------------------------------------------------------------.
+ * | Esc | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | + | Backspace | Del | 
+ * |------+------+------+------+------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Tab | Q | W | E | R | T | Y | U | I | O | P | { | } | \ | PgUp |
+ * |---------+------+------+------+------+------+------+------+------+------+------+------+------+----------+------|
+ * | Capslock | A | S | D | F | G | H | J | K | L | ; | " | Enter | PgDn |
+ * |------------+------+------+------+------+------|------+------+------+------+------+------+------+-------+------|
+ * | SHIFT | Z | X | C | V | B | N | M | , | . | / | Shift | Up | L1 |
+ * |--------+------+------+------+------+------+------+------+------+------+------+------+-----------+------+------|
+ * | Ctrl | Win | ALT | SPACE | L2 | L3 | Left | Down | Rght |
+ * `--------+--------+--------+------------------------------------------+------+------+------+------+------+------' 
+ */
+ [0] = LAYOUT(
+ KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_DEL, 
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_PGUP, 
+ KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_PGDN, 
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, MO(1), 
+ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, MO(2), MO(3), KC_LEFT, KC_DOWN, KC_RGHT),
+
+ /* [1]
+ * ,---------------------------------------------------------------------------------------------------------------.
+ * |Reset | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | | | 
+ * |------+------+------+------+------+------+------+------+------+------+------+------+------+-------------+------|
+ * | | PgUp | Home | Up | End | Del | \ | 7 | 8 | 9 | RTOG | RMOD | RVAI | | |
+ * |---------+------+------+------+------+------+------+------+------+------+------+------+------+----------+------|
+ * | | PgDn | Left | Down | Rght | + | - | 4 | 5 | 6 | RSAD | RVAD | | |
+ * |------------+------+------+------+------+------|------+------+------+------+------+------+--------------+------|
+ * | | Play | Mute | VolD | VolU | * | / | 1 | 2 | 3 | . | | | |
+ * |---------------+------+------+------+------+------+------+------+------+------+------+-----------+------+------|
+ * | Ctrl | Win | ALT | 0 | | | | | |
+ * `--------+--------+--------+-------------------------------------------+---------+---------+------+------+------' 
+ */
+ [1] = LAYOUT(
+ QK_BOOT, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_TRNS, KC_TRNS, 
+ KC_TRNS, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, KC_BSLS, KC_7, KC_8, KC_9, RGB_TOG, RGB_MOD, RGB_VAI, KC_TRNS, KC_TRNS, 
+ KC_TRNS, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, RGB_SAI, RGB_SAD, KC_TRNS, KC_TRNS, 
+ KC_TRNS, KC_MPLY, KC_MUTE, KC_VOLD, KC_VOLU, KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, KC_DOT, KC_TRNS, KC_TRNS, KC_TRNS,
+ KC_TRNS, KC_TRNS, KC_TRNS, KC_0, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS)
+}; 
+
+const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS({36, 1, HSV_RED});
+const rgblight_segment_t PROGMEM my_ar_numpad_layer[] = RGBLIGHT_LAYER_SEGMENTS({45, 2, HSV_WHITE});
+const rgblight_segment_t PROGMEM my_symbol_layer[] = RGBLIGHT_LAYER_SEGMENTS({30, 2, HSV_WHITE});
+const rgblight_segment_t PROGMEM my_other_layer[] = RGBLIGHT_LAYER_SEGMENTS({16, 2, HSV_WHITE});
+
+const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(
+ my_capslock_layer, // Caplock indicator
+ my_ar_numpad_layer, // Arrow keys & Numpad, Operator keys, reset key, RGB control and media control
+ my_symbol_layer, // F1-F12 keys & Symbols
+ my_other_layer // Self-Defined
+);
+void keyboard_post_init_user(void) {
+ rgblight_layers = my_rgb_layers;
+}
+
+bool led_update_user(led_t led_state) {
+ rgblight_set_layer_state(0, led_state.caps_lock);
+ return true;
+}
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+ rgblight_set_layer_state(1, layer_state_cmp(state, 1));
+ rgblight_set_layer_state(2, layer_state_cmp(state, 2));
+ rgblight_set_layer_state(3, layer_state_cmp(state, 3));
+ return state;
+}
+
diff --git a/keyboards/quarkeys/z67/hotswap/keymaps/via/keymap.c b/keyboards/quarkeys/z67/hotswap/keymaps/via/keymap.c
@@ -0,0 +1,59 @@
+/* 
+/ Copyright 2022 quarkeys
+/ 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:https://www.gnu.org/licenses/>.
+*/
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+ [0] = LAYOUT(
+ KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_DEL, 
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, KC_PGUP, 
+ KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_PGDN, 
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, MO(1), 
+ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, MO(2), MO(3), KC_LEFT, KC_DOWN, KC_RGHT),
+
+ [1] = LAYOUT(
+ QK_BOOT, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_TRNS, KC_TRNS, 
+ KC_TRNS, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, KC_BSLS, KC_7, KC_8, KC_9, RGB_TOG, RGB_MOD, RGB_VAI, KC_TRNS, KC_TRNS, 
+ KC_TRNS, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, RGB_SAI, RGB_SAD, KC_TRNS, KC_TRNS, 
+ KC_TRNS, KC_MPLY, KC_MUTE, KC_VOLD, KC_VOLU, KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, KC_DOT, KC_TRNS, KC_TRNS, KC_TRNS,
+ KC_TRNS, KC_TRNS, KC_TRNS, KC_0, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS)
+}; 
+
+const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS({36, 1, HSV_RED});
+const rgblight_segment_t PROGMEM my_ar_numpad_layer[] = RGBLIGHT_LAYER_SEGMENTS({45, 2, HSV_WHITE});
+const rgblight_segment_t PROGMEM my_symbol_layer[] = RGBLIGHT_LAYER_SEGMENTS({30, 2, HSV_WHITE});
+const rgblight_segment_t PROGMEM my_other_layer[] = RGBLIGHT_LAYER_SEGMENTS({16, 2, HSV_WHITE});
+
+const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(
+ my_capslock_layer, // Caplock indicator
+ my_ar_numpad_layer, // Arrow keys & Numpad, Operator keys, reset key, RGB control and media control
+ my_symbol_layer, // F1-F12 keys & Symbols
+ my_other_layer // Self-Defined
+);
+void keyboard_post_init_user(void) {
+ rgblight_layers = my_rgb_layers;
+}
+
+bool led_update_user(led_t led_state) {
+ rgblight_set_layer_state(0, led_state.caps_lock);
+ return true;
+}
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+ rgblight_set_layer_state(1, layer_state_cmp(state, 1));
+ rgblight_set_layer_state(2, layer_state_cmp(state, 2));
+ rgblight_set_layer_state(3, layer_state_cmp(state, 3));
+ return state;
+}
+
diff --git a/keyboards/quarkeys/z67/hotswap/keymaps/via/rules.mk b/keyboards/quarkeys/z67/hotswap/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+LTO_ENABLE = yes
diff --git a/keyboards/quarkeys/z67/hotswap/rules.mk b/keyboards/quarkeys/z67/hotswap/rules.mk
@@ -0,0 +1,12 @@
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = yes # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = no # Console for debug
+COMMAND_ENABLE = no # Commands for debug and configuration
+NKRO_ENABLE = yes # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
+AUDIO_ENABLE = no # Audio output
diff --git a/keyboards/quarkeys/z67/readme.md b/keyboards/quarkeys/z67/readme.md
@@ -0,0 +1,19 @@
+# Quarkeys Z67 Keyboard
+
+A 65% Gasket keyboard made by Quarkeys Studio, third of our projects.
+
+* Keyboard Maintainer: [Quarkeys Studio](www.quarkeys.com)
+* Hardware Supported: Z67-YUN
+* Hardware Specs: Solder version with throught hole for LEDs, hotswap version with per-key RGBs, layer & Capslock indicators
+
+Make example for this keyboard solder version keymap(after setting up your build environment):
+
+ make quarkeys/z67/solder:default
+
+Flashing example for this keyboard:
+
+ make quarkeys/z67/solder:default:flash
+
+**Bootloader:** Press the `QK_BOOT` keycode at ESC position of layer 1.
+
+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).