From 3a7573436ae6ab20973389a4051a8785399539f2 Mon Sep 17 00:00:00 2001
From: James Young <18669334+noroadsleft@users.noreply.github.com>
Date: Fri, 22 Jan 2021 18:02:40 -0800
Subject: Program Yoink! refactor (#11636)
* split config.h for each variant
* split rules.mk for each variant
* split source and header files for each variant
* move keymaps to the appropriate variant
* update keyboard readme
* update keymap readmes
* differentiate Staggered and Ortho USB Device Strings
* clean up formatting in info.json
* split info.json files for each variant
* break up the info.json for readability
* correct key positioning and board dimensions
* correct key object sequences
* add weak encoder function to keyboard level
Allows Configurator-compiled firmware to have encoder functionality.
* add variant-specific readme files and bootloader instructions
---
keyboards/program_yoink/ortho/config.h | 19 ++++
keyboards/program_yoink/ortho/info.json | 118 +++++++++++++++++++++
.../program_yoink/ortho/keymaps/default/config.h | 25 +++++
.../program_yoink/ortho/keymaps/default/keymap.c | 75 +++++++++++++
.../program_yoink/ortho/keymaps/default/readme.md | 1 +
.../program_yoink/ortho/keymaps/default/rules.mk | 1 +
.../ortho/keymaps/ortho_split/config.h | 25 +++++
.../ortho/keymaps/ortho_split/keymap.c | 75 +++++++++++++
.../ortho/keymaps/ortho_split/readme.md | 1 +
.../ortho/keymaps/ortho_split/rules.mk | 1 +
keyboards/program_yoink/ortho/ortho.c | 17 +++
keyboards/program_yoink/ortho/ortho.h | 55 ++++++++++
keyboards/program_yoink/ortho/readme.md | 18 ++++
keyboards/program_yoink/ortho/rules.mk | 0
14 files changed, 431 insertions(+)
create mode 100644 keyboards/program_yoink/ortho/config.h
create mode 100644 keyboards/program_yoink/ortho/info.json
create mode 100644 keyboards/program_yoink/ortho/keymaps/default/config.h
create mode 100644 keyboards/program_yoink/ortho/keymaps/default/keymap.c
create mode 100644 keyboards/program_yoink/ortho/keymaps/default/readme.md
create mode 100644 keyboards/program_yoink/ortho/keymaps/default/rules.mk
create mode 100644 keyboards/program_yoink/ortho/keymaps/ortho_split/config.h
create mode 100644 keyboards/program_yoink/ortho/keymaps/ortho_split/keymap.c
create mode 100644 keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md
create mode 100644 keyboards/program_yoink/ortho/keymaps/ortho_split/rules.mk
create mode 100644 keyboards/program_yoink/ortho/ortho.c
create mode 100644 keyboards/program_yoink/ortho/ortho.h
create mode 100644 keyboards/program_yoink/ortho/readme.md
create mode 100644 keyboards/program_yoink/ortho/rules.mk
(limited to 'keyboards/program_yoink/ortho')
diff --git a/keyboards/program_yoink/ortho/config.h b/keyboards/program_yoink/ortho/config.h
new file mode 100644
index 0000000000..7620643f1a
--- /dev/null
+++ b/keyboards/program_yoink/ortho/config.h
@@ -0,0 +1,19 @@
+/*
+Copyright 2020 melonbred
+
+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 .
+*/
+
+#define PRODUCT_ID 0xF10C
+#define PRODUCT Program Yoink! Ortho
diff --git a/keyboards/program_yoink/ortho/info.json b/keyboards/program_yoink/ortho/info.json
new file mode 100644
index 0000000000..0da81298ef
--- /dev/null
+++ b/keyboards/program_yoink/ortho/info.json
@@ -0,0 +1,118 @@
+{
+ "keyboard_name": "program_yoink",
+ "url": "",
+ "maintainer": "melonbred",
+ "width": 13.5,
+ "height": 4.25,
+ "layouts": {
+ "LAYOUT_ortho": {
+ "layout": [
+ {"x":0, "y":0},
+ {"x":1, "y":0},
+ {"x":2, "y":0},
+ {"x":3, "y":0},
+ {"x":4, "y":0},
+ {"x":5, "y":0},
+ {"x":6, "y":0},
+ {"x":7, "y":0},
+ {"x":8, "y":0},
+ {"x":9, "y":0},
+ {"x":10, "y":0},
+ {"x":11, "y":0},
+ {"x":12.5, "y":0},
+
+ {"x":0, "y":1},
+ {"x":1, "y":1},
+ {"x":2, "y":1},
+ {"x":3, "y":1},
+ {"x":4, "y":1},
+ {"x":5, "y":1},
+ {"x":6, "y":1},
+ {"x":7, "y":1},
+ {"x":8, "y":1},
+ {"x":9, "y":1},
+ {"x":10, "y":1},
+ {"x":11, "y":1},
+ {"x":12.5, "y":1},
+
+ {"x":0, "y":2},
+ {"x":1, "y":2},
+ {"x":2, "y":2},
+ {"x":3, "y":2},
+ {"x":4, "y":2},
+ {"x":5, "y":2},
+ {"x":6, "y":2},
+ {"x":7, "y":2},
+ {"x":8, "y":2},
+ {"x":9, "y":2},
+ {"x":10, "y":2},
+ {"x":11.25, "y":2.25},
+ {"x":12.5, "y":2},
+
+ {"x":0, "y":3},
+ {"x":1, "y":3},
+ {"x":2, "y":3, "w":7},
+ {"x":9, "y":3},
+ {"x":10.25, "y":3.25},
+ {"x":11.25, "y":3.25},
+ {"x":12.25, "y":3.25}
+ ]
+ },
+ "LAYOUT_ortho_split": {
+ "layout": [
+ {"x":0, "y":0},
+ {"x":1, "y":0},
+ {"x":2, "y":0},
+ {"x":3, "y":0},
+ {"x":4, "y":0},
+ {"x":5, "y":0},
+ {"x":6, "y":0},
+ {"x":7, "y":0},
+ {"x":8, "y":0},
+ {"x":9, "y":0},
+ {"x":10, "y":0},
+ {"x":11, "y":0},
+ {"x":12.5, "y":0},
+
+ {"x":0, "y":1},
+ {"x":1, "y":1},
+ {"x":2, "y":1},
+ {"x":3, "y":1},
+ {"x":4, "y":1},
+ {"x":5, "y":1},
+ {"x":6, "y":1},
+ {"x":7, "y":1},
+ {"x":8, "y":1},
+ {"x":9, "y":1},
+ {"x":10, "y":1},
+ {"x":11, "y":1},
+ {"x":12.5, "y":1},
+
+ {"x":0, "y":2},
+ {"x":1, "y":2},
+ {"x":2, "y":2},
+ {"x":3, "y":2},
+ {"x":4, "y":2},
+ {"x":5, "y":2},
+ {"x":6, "y":2},
+ {"x":7, "y":2},
+ {"x":8, "y":2},
+ {"x":9, "y":2},
+ {"x":10, "y":2},
+ {"x":11.25, "y":2.25},
+ {"x":12.5, "y":2},
+
+ {"x":0, "y":3},
+ {"x":1, "y":3},
+ {"x":2, "y":3},
+ {"x":3, "y":3, "w":2.75},
+ {"x":5.75, "y":3, "w":2.25},
+ {"x":8, "y":3},
+ {"x":9, "y":3},
+ {"x":10.25, "y":3.25},
+ {"x":11.25, "y":3.25},
+ {"x":12.25, "y":3.25}
+ ]
+ }
+ }
+}
diff --git a/keyboards/program_yoink/ortho/keymaps/default/config.h b/keyboards/program_yoink/ortho/keymaps/default/config.h
new file mode 100644
index 0000000000..ea7075aecb
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/default/config.h
@@ -0,0 +1,25 @@
+/* Copyright 2020 melonbred
+ *
+ * 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 .
+ */
+
+#pragma once
+
+// place overrides here
+#define TAPPING_TERM 200
+
+#ifdef COMBO_ENABLE
+# define COMBO_COUNT 10
+# define COMBO_TERM 60
+#endif
\ No newline at end of file
diff --git a/keyboards/program_yoink/ortho/keymaps/default/keymap.c b/keyboards/program_yoink/ortho/keymaps/default/keymap.c
new file mode 100644
index 0000000000..6f20f22ddb
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/default/keymap.c
@@ -0,0 +1,75 @@
+/* Copyright 2020 melonbred
+ *
+ * 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 .
+ */
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layers{
+ _BASE,
+ _LAYER1,
+ _LAYER2
+};
+
+// Defines Combos for use in the keymap
+enum combo_events {
+ COMBO_ENT
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_BASE] = LAYOUT_ortho(
+ KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_MPLY,
+ CTL_T(KC_TAB), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT, KC_PGUP,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_UP, KC_PGDN,
+ MO(_LAYER2), KC_LGUI, LT(_LAYER1, KC_SPC), KC_RALT, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_LAYER1] = LAYOUT_ortho(
+ 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_CAPS, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, _______, _______, KC_SCLN, KC_QUOT, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______
+ ),
+
+ [_LAYER2] = LAYOUT_ortho(
+ KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______,
+ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, RGB_M_K, RGB_M_G, RGB_M_R, RGB_M_SW, _______, RGB_HUI,
+ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, RESET, XXXXXXX, XXXXXXX, XXXXXXX, RGB_VAI, RGB_VAD, _______, RGB_HUD,
+ _______, RGB_TOG, XXXXXXX, XXXXXXX, KC_DEL, KC_RALT, KC_RCTL
+ ),
+};
+
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+ if (index == 0) {
+ if (clockwise) {
+ tap_code(KC_VOLU);
+ } else {
+ tap_code(KC_VOLD);
+ }
+ }
+}
+
+#ifdef COMBO_ENABLE
+const uint16_t PROGMEM combo_ent[] = {KC_DOT, KC_SLSH, COMBO_END};
+
+
+combo_t key_combos[COMBO_COUNT] = {
+ [COMBO_ENT] = COMBO(combo_ent,KC_ENT),
+
+};
+#endif
+
+
+
diff --git a/keyboards/program_yoink/ortho/keymaps/default/readme.md b/keyboards/program_yoink/ortho/keymaps/default/readme.md
new file mode 100644
index 0000000000..7598e7886b
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for the Program Yoink! Ortho
diff --git a/keyboards/program_yoink/ortho/keymaps/default/rules.mk b/keyboards/program_yoink/ortho/keymaps/default/rules.mk
new file mode 100644
index 0000000000..ab1e438182
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/default/rules.mk
@@ -0,0 +1 @@
+COMBO_ENABLE = yes
diff --git a/keyboards/program_yoink/ortho/keymaps/ortho_split/config.h b/keyboards/program_yoink/ortho/keymaps/ortho_split/config.h
new file mode 100644
index 0000000000..ea7075aecb
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/config.h
@@ -0,0 +1,25 @@
+/* Copyright 2020 melonbred
+ *
+ * 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 .
+ */
+
+#pragma once
+
+// place overrides here
+#define TAPPING_TERM 200
+
+#ifdef COMBO_ENABLE
+# define COMBO_COUNT 10
+# define COMBO_TERM 60
+#endif
\ No newline at end of file
diff --git a/keyboards/program_yoink/ortho/keymaps/ortho_split/keymap.c b/keyboards/program_yoink/ortho/keymaps/ortho_split/keymap.c
new file mode 100644
index 0000000000..6217124bf8
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/keymap.c
@@ -0,0 +1,75 @@
+/* Copyright 2020 melonbred
+ *
+ * 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 .
+ */
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layers{
+ _BASE,
+ _LAYER1,
+ _LAYER2
+};
+
+// Defines Combos for use in the keymap
+enum combo_events {
+ COMBO_ENT
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_BASE] = LAYOUT_ortho_split(
+ KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_MPLY,
+ CTL_T(KC_TAB), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT, KC_PGUP,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_SLSH, KC_PGDN,
+ KC_LCTL, KC_LALT, MO(_LAYER2), KC_BSPC, LT(_LAYER1, KC_SPC), KC_RGUI, KC_RALT, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_LAYER1] = LAYOUT_ortho_split(
+ 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_CAPS, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS, _______, _______, KC_SCLN, KC_QUOT, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, KC_LGUI, _______, _______, _______, _______, _______, _______, _______, _______
+ ),
+
+ [_LAYER2] = LAYOUT_ortho_split(
+ KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______,
+ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, RGB_M_K, RGB_M_G, RGB_M_R, RGB_M_SW, _______, RGB_HUI,
+ XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, RESET, XXXXXXX, XXXXXXX, XXXXXXX, RGB_VAI, RGB_VAD, _______, RGB_HUD,
+ _______, RGB_TOG, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, KC_DEL, KC_RALT, KC_RCTL
+ ),
+};
+
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+ if (index == 0) {
+ if (clockwise) {
+ tap_code(KC_VOLU);
+ } else {
+ tap_code(KC_VOLD);
+ }
+ }
+}
+
+#ifdef COMBO_ENABLE
+const uint16_t PROGMEM combo_ent[] = {KC_K, KC_L, COMBO_END};
+
+
+combo_t key_combos[COMBO_COUNT] = {
+ [COMBO_ENT] = COMBO(combo_ent,KC_ENT),
+
+};
+#endif
+
+
+
diff --git a/keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md b/keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md
new file mode 100644
index 0000000000..36a1385a31
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/readme.md
@@ -0,0 +1 @@
+# The split space bar keymap for the Program Yoink! Ortho
diff --git a/keyboards/program_yoink/ortho/keymaps/ortho_split/rules.mk b/keyboards/program_yoink/ortho/keymaps/ortho_split/rules.mk
new file mode 100644
index 0000000000..ab1e438182
--- /dev/null
+++ b/keyboards/program_yoink/ortho/keymaps/ortho_split/rules.mk
@@ -0,0 +1 @@
+COMBO_ENABLE = yes
diff --git a/keyboards/program_yoink/ortho/ortho.c b/keyboards/program_yoink/ortho/ortho.c
new file mode 100644
index 0000000000..a8e1b732a9
--- /dev/null
+++ b/keyboards/program_yoink/ortho/ortho.c
@@ -0,0 +1,17 @@
+/* Copyright 2020 melonbred
+ *
+ * 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 .
+ */
+
+#include "ortho.h"
diff --git a/keyboards/program_yoink/ortho/ortho.h b/keyboards/program_yoink/ortho/ortho.h
new file mode 100644
index 0000000000..c906d2e247
--- /dev/null
+++ b/keyboards/program_yoink/ortho/ortho.h
@@ -0,0 +1,55 @@
+/* Copyright 2020 melonbred
+ *
+ * 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 .
+ */
+
+#pragma once
+
+#include "program_yoink.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define XXX KC_NO
+
+#define LAYOUT_ortho( \
+ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \
+ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \
+ K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \
+ K30, K31, K35, K39, K3A, K3B, K3C \
+) \
+{ \
+ { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C }, \
+ { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C }, \
+ { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \
+ { K30, K31, XXX, XXX, XXX, K35, XXX, XXX, XXX, K39, K3A, K3B, K3C } \
+}
+
+#define LAYOUT_ortho_split( \
+ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, \
+ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, \
+ K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \
+ K30, K31, K32, K34, K36, K38, K39, K3A, K3B, K3C \
+) \
+{ \
+ { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C }, \
+ { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C }, \
+ { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C }, \
+ { K30, K31, K32, XXX, K34, XXX, K36, XXX, K38, K39, K3A, K3B, K3C } \
+}
diff --git a/keyboards/program_yoink/ortho/readme.md b/keyboards/program_yoink/ortho/readme.md
new file mode 100644
index 0000000000..c77154db64
--- /dev/null
+++ b/keyboards/program_yoink/ortho/readme.md
@@ -0,0 +1,18 @@
+# Program Yoink! Ortho
+
+Program Yoink is a 12u main cluster board accompanied by a macro column with optional encoder support and arrow keys.
+
+* Keyboard Maintainer: [melonbred](https://github.com/melonbred)
+* Hardware Supported: Program Yoink! Ortho PCB (ATmega32u2)
+* Hardware Availability: [P3D Store](https://p3dstore.com/products/yoink-gb)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make program_yoink/ortho:default
+
+To reset the board into bootloader mode, do one of the following:
+
+* Tap the Reset switch mounted on the bottom side of the PCB
+* Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings)
+
+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).
diff --git a/keyboards/program_yoink/ortho/rules.mk b/keyboards/program_yoink/ortho/rules.mk
new file mode 100644
index 0000000000..e69de29bb2
--
cgit v1.2.3