Merge remote-tracking branch 'origin/master' into develop

16 files changed, 381 insertions, 0 deletions

diff --git a/keyboards/custommk/elysian/config.h b/keyboards/custommk/elysian/config.h
new file mode 100644
index 0000000000..03a7586655
--- /dev/null
+++ b/keyboards/custommk/elysian/config.h
@@ -0,0 +1,14 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+// FRAM configuration
+#define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN B7
+#define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR 4
+
+// SPI configuration
+#define SPI_DRIVER SPID1
+#define SPI_SCK_PIN B3
+#define SPI_MOSI_PIN B5
+#define SPI_MISO_PIN B4
\ No newline at end of file
diff --git a/keyboards/custommk/elysian/halconf.h b/keyboards/custommk/elysian/halconf.h
new file mode 100644
index 0000000000..5b2f7eedd2
--- /dev/null
+++ b/keyboards/custommk/elysian/halconf.h
@@ -0,0 +1,14 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define HAL_USE_SPI TRUE
+
+#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD
+
+#define SERIAL_BUFFERS_SIZE 256
+
+#define SPI_USE_WAIT TRUE
+
+#include_next <halconf.h>
diff --git a/keyboards/custommk/elysian/keyboard.json b/keyboards/custommk/elysian/keyboard.json
new file mode 100644
index 0000000000..4fc842149d
--- /dev/null
+++ b/keyboards/custommk/elysian/keyboard.json
@@ -0,0 +1,65 @@
+{
+    "manufacturer": "customMK",
+    "keyboard_name": "Elysian",
+    "maintainer": "customMK",
+    "bootloader": "stm32-dfu",
+    "debounce": 10,
+    "diode_direction": "ROW2COL",
+    "dynamic_keymap": {
+        "layer_count": 32
+    },
+    "eeprom": {
+        "driver": "spi"
+    },
+    "features": {
+        "bootmagic": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "encoder": true
+    },
+    "matrix_pins": {
+        "cols": ["A0", "A1", "A2", "A3", "A4"],
+        "rows": ["B0", "B1", "B6", "B8"]
+    },
+    "processor": "STM32F411",
+    "qmk": {
+        "tap_keycode_delay": 10
+    },
+    "url": "https://shop.custommk.com/collections/elysian/products/elysian",
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0xFABB",
+        "vid": "0xF35B",
+        "force_nkro": true
+    },
+    "encoder": {
+        "rotary": [
+            { "pin_a": "A5", "pin_b": "A6", "resolution": 2},
+            { "pin_a": "A7", "pin_b": "A8", "resolution": 2}
+        ]
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"matrix": [0, 0], "x": 0, "y": 0},
+                {"matrix": [0, 1], "x": 1, "y": 0},
+                {"matrix": [1, 0], "x": 0, "y": 1},
+                {"matrix": [1, 1], "x": 1, "y": 1},
+                {"matrix": [1, 2], "x": 2, "y": 1},
+                {"matrix": [1, 3], "x": 3, "y": 1},
+                {"matrix": [1, 4], "x": 4, "y": 1},
+                {"matrix": [2, 0], "x": 0, "y": 2},
+                {"matrix": [2, 1], "x": 1, "y": 2},
+                {"matrix": [2, 2], "x": 2, "y": 2},
+                {"matrix": [2, 3], "x": 3, "y": 2},
+                {"matrix": [2, 4], "x": 4, "y": 2},
+                {"matrix": [3, 0], "x": 0, "y": 3},
+                {"matrix": [3, 1], "x": 1, "y": 3},
+                {"matrix": [3, 2], "x": 2, "y": 3},
+                {"matrix": [3, 3], "x": 3, "y": 3},
+                {"matrix": [3, 4], "x": 4, "y": 3}
+            ]
+        }
+    }
+}
\ No newline at end of file
diff --git a/keyboards/custommk/elysian/keymaps/default/keymap.c b/keyboards/custommk/elysian/keymaps/default/keymap.c
new file mode 100644
index 0000000000..fcb617ad9e
--- /dev/null
+++ b/keyboards/custommk/elysian/keymaps/default/keymap.c
@@ -0,0 +1,19 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_ESC, KC_ENT,
+        KC_Y,   KC_U,   KC_I,     KC_O,   KC_P,
+        KC_H,   KC_J,   KC_K,     KC_L,   KC_SCLN,  
+        KC_N,   KC_M,   KC_COMMA, KC_DOT, KC_SLASH
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [0] =   { ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_WH_D, KC_WH_U) }
+};
+#endif
\ No newline at end of file
diff --git a/keyboards/custommk/elysian/keymaps/default/rules.mk b/keyboards/custommk/elysian/keymaps/default/rules.mk
new file mode 100644
index 0000000000..a40474b4d5
--- /dev/null
+++ b/keyboards/custommk/elysian/keymaps/default/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes
\ No newline at end of file
diff --git a/keyboards/custommk/elysian/keymaps/via/config.h b/keyboards/custommk/elysian/keymaps/via/config.h
new file mode 100644
index 0000000000..c2dca38277
--- /dev/null
+++ b/keyboards/custommk/elysian/keymaps/via/config.h
@@ -0,0 +1,6 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define DYNAMIC_KEYMAP_MACRO_COUNT 128
diff --git a/keyboards/custommk/elysian/keymaps/via/keymap.c b/keyboards/custommk/elysian/keymaps/via/keymap.c
new file mode 100644
index 0000000000..493a7834e8
--- /dev/null
+++ b/keyboards/custommk/elysian/keymaps/via/keymap.c
@@ -0,0 +1,19 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT(
+        KC_ESC, MO(1),
+        KC_Y,   KC_U, KC_I,     KC_O,   KC_P,
+        KC_H,   KC_J, KC_K,     KC_L,   KC_SCLN,  
+        KC_N,   KC_M, KC_COMMA, KC_DOT, KC_SLASH
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [0] =   { ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_WH_D, KC_WH_U) }
+};
+#endif
\ No newline at end of file
diff --git a/keyboards/custommk/elysian/keymaps/via/rules.mk b/keyboards/custommk/elysian/keymaps/via/rules.mk
new file mode 100644
index 0000000000..4253f570f0
--- /dev/null
+++ b/keyboards/custommk/elysian/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
\ No newline at end of file
diff --git a/keyboards/custommk/elysian/mcuconf.h b/keyboards/custommk/elysian/mcuconf.h
new file mode 100644
index 0000000000..42dbcf352a
--- /dev/null
+++ b/keyboards/custommk/elysian/mcuconf.h
@@ -0,0 +1,10 @@
+// Copyright 2024 customMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include_next <mcuconf.h>
+
+// FRAM
+#undef STM32_SPI_USE_SPI1
+#define STM32_SPI_USE_SPI1 TRUE
diff --git a/keyboards/custommk/elysian/readme.md b/keyboards/custommk/elysian/readme.md
new file mode 100644
index 0000000000..7b508758ca
--- /dev/null
+++ b/keyboards/custommk/elysian/readme.md
@@ -0,0 +1,27 @@
+# Elysian
+
+![Elysian](https://i.imgur.com/W8yx11qh.jpeg)
+
+Elysian is a 3x5 macropad including two rotary encoders.
+
+* Keyboard Maintainer: [customMK](https://github.com/customMK)
+* Hardware Supported: Elysian
+* Hardware Availability: [customMK](https://shop.custommk.com/collections/keyboards/products/elysian)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make custommk/elysian:default
+
+Flashing example for this keyboard:
+
+    make custommk/elysian:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Press and hold down the rotary encoder at (0,0) in the matrix (the rotary encoder in the top left corner) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
diff --git a/keyboards/tyraelwastaken/equanimity/keyboard.json b/keyboards/tyraelwastaken/equanimity/keyboard.json
new file mode 100644
index 0000000000..d9ace04714
--- /dev/null
+++ b/keyboards/tyraelwastaken/equanimity/keyboard.json
@@ -0,0 +1,104 @@
+{
+    "manufacturer": "TyraelWasTaken",
+    "keyboard_name": "Equanimity",
+    "maintainer": "TyraelWasTaken",
+    "bootloader": "stm32-dfu",
+    "diode_direction": "COL2ROW",
+    "encoder": {
+        "rotary": [
+            {"pin_a": "A9", "pin_b": "A10", "resolution": 1}
+        ]
+    },
+    "features": {
+        "bootmagic": true,
+        "encoder": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true
+    },
+    "matrix_pins": {
+        "cols": ["B2", "B1", "B0", "A7", "A6", "A5", "A2", "B12", "B9", "B8", "B7", "B6", "B5", "B4", "B3", "A15"],
+        "rows": ["B11", "B10", "A1", "A3", "A4"]
+    },
+    "processor": "STM32F072",
+    "url": "https://github.com/TyraelWasTaken/Equanimity",
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x5343",
+        "vid": "0x6571"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"matrix": [0, 0], "x": 0, "y": 0},
+                {"matrix": [0, 1], "x": 1, "y": 0},
+                {"matrix": [0, 2], "x": 2, "y": 0},
+                {"matrix": [0, 3], "x": 3, "y": 0},
+                {"matrix": [0, 4], "x": 4, "y": 0},
+                {"matrix": [0, 5], "x": 5, "y": 0},
+                {"matrix": [0, 6], "x": 6, "y": 0},
+                {"matrix": [0, 7], "x": 7, "y": 0},
+                {"matrix": [0, 8], "x": 8, "y": 0},
+                {"matrix": [0, 9], "x": 9, "y": 0},
+                {"matrix": [0, 10], "x": 10, "y": 0},
+                {"matrix": [0, 11], "x": 11, "y": 0},
+                {"matrix": [0, 12], "x": 12, "y": 0},
+                {"matrix": [0, 13], "x": 13, "y": 0},
+                {"matrix": [0, 14], "x": 14, "y": 0},
+                {"matrix": [1, 0], "x": 0, "y": 1},
+                {"matrix": [1, 1], "x": 1, "y": 1},
+                {"matrix": [1, 2], "x": 2, "y": 1},
+                {"matrix": [1, 3], "x": 3, "y": 1},
+                {"matrix": [1, 4], "x": 4, "y": 1},
+                {"matrix": [1, 5], "x": 5, "y": 1},
+                {"matrix": [1, 6], "x": 6, "y": 1},
+                {"matrix": [1, 8], "x": 8, "y": 1},
+                {"matrix": [1, 9], "x": 9, "y": 1},
+                {"matrix": [1, 10], "x": 10, "y": 1},
+                {"matrix": [1, 11], "x": 11, "y": 1},
+                {"matrix": [1, 12], "x": 12, "y": 1},
+                {"matrix": [1, 13], "x": 13, "y": 1},
+                {"matrix": [1, 14], "x": 14, "y": 1},
+                {"matrix": [1, 15], "x": 15, "y": 1},
+                {"matrix": [2, 0], "x": 0, "y": 2},
+                {"matrix": [2, 1], "x": 1, "y": 2},
+                {"matrix": [2, 2], "x": 2, "y": 2},
+                {"matrix": [2, 3], "x": 3, "y": 2},
+                {"matrix": [2, 4], "x": 4, "y": 2},
+                {"matrix": [2, 5], "x": 5, "y": 2},
+                {"matrix": [2, 6], "x": 6, "y": 2},
+                {"matrix": [2, 8], "x": 8, "y": 2},
+                {"matrix": [2, 9], "x": 9, "y": 2},
+                {"matrix": [2, 10], "x": 10, "y": 2},
+                {"matrix": [2, 11], "x": 11, "y": 2},
+                {"matrix": [2, 12], "x": 12, "y": 2},
+                {"matrix": [2, 13], "x": 13, "y": 2},
+                {"matrix": [2, 14], "x": 14, "y": 2},
+                {"matrix": [2, 15], "x": 15, "y": 2},
+                {"matrix": [3, 0], "x": 0, "y": 3},
+                {"matrix": [3, 1], "x": 1, "y": 3},
+                {"matrix": [3, 2], "x": 2, "y": 3},
+                {"matrix": [3, 3], "x": 3, "y": 3},
+                {"matrix": [3, 4], "x": 4, "y": 3},
+                {"matrix": [3, 5], "x": 5, "y": 3},
+                {"matrix": [3, 6], "x": 6, "y": 3},
+                {"matrix": [3, 8], "x": 8, "y": 3},
+                {"matrix": [3, 9], "x": 9, "y": 3},
+                {"matrix": [3, 10], "x": 10, "y": 3},
+                {"matrix": [3, 11], "x": 11, "y": 3},
+                {"matrix": [3, 12], "x": 12, "y": 3},
+                {"matrix": [3, 13], "x": 13, "y": 3},
+                {"matrix": [3, 14], "x": 14, "y": 3},
+                {"matrix": [4, 1], "x": 1, "y": 4},
+                {"matrix": [4, 3], "x": 3, "y": 4},
+                {"matrix": [4, 5], "x": 5, "y": 4},
+                {"matrix": [4, 7], "x": 7, "y": 4},
+                {"matrix": [4, 8], "x": 8, "y": 4},
+                {"matrix": [4, 10], "x": 10, "y": 4},
+                {"matrix": [4, 12], "x": 12, "y": 4},
+                {"matrix": [4, 13], "x": 13, "y": 4},
+                {"matrix": [4, 15], "x": 5, "y": 4}
+            ]
+        }
+    }
+}
diff --git a/keyboards/tyraelwastaken/equanimity/keymaps/default/keymap.c b/keyboards/tyraelwastaken/equanimity/keymaps/default/keymap.c
new file mode 100644
index 0000000000..7430554f7a
--- /dev/null
+++ b/keyboards/tyraelwastaken/equanimity/keymaps/default/keymap.c
@@ -0,0 +1,35 @@
+// Copyright 2024 TyraelWasTaken (@TyraelWasTaken)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+    _BL,
+    _FL,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [_BL] = LAYOUT(
+        KC_DELETE, KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINUS, KC_EQUAL, KC_BACKSPACE,
+        KC_HOME, 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_LOCK, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOTE, KC_ENT, KC_MEDIA_PLAY_PAUSE,
+        KC_PGDN, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMMA, KC_DOT, KC_SLASH, KC_RSFT, KC_UP,
+        KC_LCTL, KC_LGUI, KC_SPC, MO(_FL), KC_SPC, KC_LALT, KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+
+    [_FL] = LAYOUT(
+        KC_TRNS, KC_GRAVE, 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_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PGUP,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_HOME, KC_PGDN, KC_END
+    )  
+};
+
+#ifdef ENCODER_MAP_ENABLE
+    const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+        [_BL] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+        [_FL] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    };
+#endif
\ No newline at end of file
diff --git a/keyboards/tyraelwastaken/equanimity/keymaps/default/rules.mk b/keyboards/tyraelwastaken/equanimity/keymaps/default/rules.mk
new file mode 100644
index 0000000000..a40474b4d5
--- /dev/null
+++ b/keyboards/tyraelwastaken/equanimity/keymaps/default/rules.mk
@@ -0,0 +1 @@
+ENCODER_MAP_ENABLE = yes
\ No newline at end of file
diff --git a/keyboards/tyraelwastaken/equanimity/keymaps/via/keymap.c b/keyboards/tyraelwastaken/equanimity/keymaps/via/keymap.c
new file mode 100644
index 0000000000..7430554f7a
--- /dev/null
+++ b/keyboards/tyraelwastaken/equanimity/keymaps/via/keymap.c
@@ -0,0 +1,35 @@
+// Copyright 2024 TyraelWasTaken (@TyraelWasTaken)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+    _BL,
+    _FL,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+    [_BL] = LAYOUT(
+        KC_DELETE, KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINUS, KC_EQUAL, KC_BACKSPACE,
+        KC_HOME, 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_LOCK, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOTE, KC_ENT, KC_MEDIA_PLAY_PAUSE,
+        KC_PGDN, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMMA, KC_DOT, KC_SLASH, KC_RSFT, KC_UP,
+        KC_LCTL, KC_LGUI, KC_SPC, MO(_FL), KC_SPC, KC_LALT, KC_LEFT, KC_DOWN, KC_RGHT
+    ),
+
+    [_FL] = LAYOUT(
+        KC_TRNS, KC_GRAVE, 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_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_PGUP,
+        KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_HOME, KC_PGDN, KC_END
+    )  
+};
+
+#ifdef ENCODER_MAP_ENABLE
+    const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+        [_BL] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },
+        [_FL] = { ENCODER_CCW_CW(KC_TRNS, KC_TRNS) },
+    };
+#endif
\ No newline at end of file
diff --git a/keyboards/tyraelwastaken/equanimity/keymaps/via/rules.mk b/keyboards/tyraelwastaken/equanimity/keymaps/via/rules.mk
new file mode 100644
index 0000000000..4253f570f0
--- /dev/null
+++ b/keyboards/tyraelwastaken/equanimity/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
\ No newline at end of file
diff --git a/keyboards/tyraelwastaken/equanimity/readme.md b/keyboards/tyraelwastaken/equanimity/readme.md
new file mode 100644
index 0000000000..a866226192
--- /dev/null
+++ b/keyboards/tyraelwastaken/equanimity/readme.md
@@ -0,0 +1,27 @@
+# equanimity
+
+![equanimity](https://i.imgur.com/kIGyOi4.png)
+
+Arisu-ish Alice keyboard with an EC11 and some accent keys, staggered.
+
+* Keyboard Maintainer: [TyraelWasTaken](https://github.com/TyraelWasTaken)
+* Hardware Supported: *UDB C3 or greater with Equanimity PCB, no other PCBs are supported for the case*
+* Hardware Availability: *If you wish to build this, all files are available here: https://github.com/TyraelWasTaken/Equanimity*
+
+Make example for this keyboard (after setting up your build environment):
+
+    make tyraelwastaken/equanimity:default
+
+Flashing example for this keyboard:
+
+    make tyraelwastaken/equanimity:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
\ No newline at end of file