Move ckeys workshop to its own directory (#2928)

* move obelus and nakey to ckeys directory

* delete the originals

* short readme about ckeys

* edit readmes to reflect new changes

* add build guide info..and here's me trying to retrigger the build job

8 files changed, 429 insertions, 0 deletions

diff --git a/keyboards/ckeys/obelus/config.h b/keyboards/ckeys/obelus/config.h
new file mode 100644
index 0000000000..a1451c1420
--- /dev/null
+++ b/keyboards/ckeys/obelus/config.h
@@ -0,0 +1,168 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+
+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/>.
+*/
+
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x6060
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    You
+#define PRODUCT         obelus
+#define DESCRIPTION     4x4 QMK test platform
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 4
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+*/
+#define MATRIX_ROW_PINS { F4, F5, F6, F7 }
+#define MATRIX_COL_PINS { F0, F1, B2, B3 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
+#define DIODE_DIRECTION COL2ROW
+
+#define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 3
+
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCING_DELAY 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* key combination for magic key command */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#define MAGIC_KEY_HELP1          H
+//#define MAGIC_KEY_HELP2          SLASH
+//#define MAGIC_KEY_DEBUG          D
+//#define MAGIC_KEY_DEBUG_MATRIX   X
+//#define MAGIC_KEY_DEBUG_KBD      K
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#define MAGIC_KEY_LAYER0_ALT1    ESC
+//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
+//#define MAGIC_KEY_LAYER0         0
+//#define MAGIC_KEY_LAYER1         1
+//#define MAGIC_KEY_LAYER2         2
+//#define MAGIC_KEY_LAYER3         3
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#define MAGIC_KEY_BOOTLOADER     PAUSE
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#define MAGIC_KEY_NKRO           N
+//#define MAGIC_KEY_SLEEP_LED      Z
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
+
+#ifdef AUDIO_ENABLE
+  #define AUDIO_VOICES
+  #define C6_AUDIO
+  #define STARTUP_SONG SONG(STARTUP_SOUND)
+#endif
+
+#endif
diff --git a/keyboards/ckeys/obelus/keymaps/default/config.h b/keyboards/ckeys/obelus/keymaps/default/config.h
new file mode 100644
index 0000000000..04bf9f4a9d
--- /dev/null
+++ b/keyboards/ckeys/obelus/keymaps/default/config.h
@@ -0,0 +1,6 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+// Add overrides here 
+#endif
diff --git a/keyboards/ckeys/obelus/keymaps/default/keymap.c b/keyboards/ckeys/obelus/keymaps/default/keymap.c
new file mode 100644
index 0000000000..a9b15e9347
--- /dev/null
+++ b/keyboards/ckeys/obelus/keymaps/default/keymap.c
@@ -0,0 +1,116 @@
+#include "obelus.h"
+#include "action_layer.h"
+#ifdef AUDIO_ENABLE
+  #include "audio.h"
+#endif
+
+extern keymap_config_t keymap_config;
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  /* LAYERS
+   * ,-----------------------.
+   * |     |     |     |RESET|
+   * |-----+-----+-----+-----|
+   * |MUSIC|     |     |     |
+   * |-----+-----+-----+-----|
+   * |NUMPD| NAV |GAMES|     |
+   * |-----+-----+-----+-----|
+   * |     |     |     |     |
+   * `---------------------- '
+   */
+[0] = KEYMAP( /* LAYER SELECT */
+  KC_TRNS, KC_TRNS, KC_TRNS, RESET, \
+  TO(4),   KC_TRNS, KC_TRNS, KC_TRNS, \
+  TO(1),   TO(2),   TO(3),   KC_TRNS, \
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS  \
+),
+  /* NUMPAD
+   * ,-----------------------.
+   * |  7  |  8  |  9  |  *  |
+   * |-----+-----+-----+-----|
+   * |  4  |  5  |  6  |  -  |
+   * |-----+-----+-----+-----|
+   * |  1  |  2  |  3  |  +  |
+   * |-----+-----+-----+-----|
+   * |  0  |  .  |  /  |  =  |
+   * `---------------------- '
+   */
+[1] = KEYMAP( /* NUMPAD */
+  KC_P7,   KC_P8,   KC_P9,   KC_PAST, \
+  KC_P4,   KC_P5,   KC_P6,   KC_PMNS, \
+  KC_P1,   KC_P2,   KC_P3,   KC_PPLS, \
+  KC_P0,   KC_PDOT, KC_PSLS, LT(5,KC_PENT) \
+),
+  /* NUMPAD SUPPLEMENT
+   * ,-----------------------.
+   * |NUMLK|     |     |     |
+   * |-----+-----+-----+-----|
+   * |     |     |     |     |
+   * |-----+-----+-----+-----|
+   * |     |     |     |     |
+   * |-----+-----+-----+-----|
+   * |     |     |     |     |
+   * `---------------------- '
+   */
+[5] = KEYMAP( /* NUMPAD SUPPLEMENT */
+  KC_NLCK, KC_TRNS, KC_TRNS, TO(0),   \
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, \
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, \
+  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS \
+),
+  /* NAV
+   * ,-----------------------.
+   * | INS |PGUP | TAB |PRSCR|
+   * |-----+-----+-----+-----|
+   * | DEL |PGDN |VOLD |VOLU |
+   * |-----+-----+-----+-----|
+   * |HOME | UP  | END |     |
+   * |-----+-----+-----+-----|
+   * |LEFT |DOWN |RIGHT|ENTER|
+   * `---------------------- '
+   */
+[2] = KEYMAP( /* NAV CLUSTER */
+  KC_INS,  KC_PGUP, KC_TAB,  KC_PSCR, \
+  KC_DEL,  KC_PGDN, KC_VOLD, KC_VOLU, \
+  KC_HOME, KC_UP,   KC_END,  TO(0),   \
+  KC_LEFT, KC_DOWN, KC_RGHT, KC_ENT \
+),
+  /* GAMING
+   * ,-----------------------.
+   * | ESC |  1  |  2  |  3  |
+   * |-----+-----+-----+-----|
+   * | TAB |  Q  |  W  |  E  |
+   * |-----+-----+-----+-----|
+   * |SHIFT|  A  |  S  |  D  |
+   * |-----+-----+-----+-----|
+   * |CTRL |  C  |  R  |SPACE|
+   * `---------------------- '
+   */
+[3] = KEYMAP( /* GAMING */
+  LT(4, KC_ESC),  KC_1,    KC_2,    KC_3,    \
+  KC_TAB,  KC_Q,    KC_W,    KC_E,    \
+  KC_LSFT, KC_A,    KC_S,    KC_D,    \
+  KC_LCTL, KC_C,    KC_R,    KC_SPC \
+),
+  /* MUSIC
+   * ,-----------------------.
+   * |     |     |     |     |
+   * |-----+-----+-----+-----|
+   * |     |     |     |     |
+   * |-----+-----+-----+-----|
+   * |     |     |     |     |
+   * |-----+-----+-----+-----|
+   * |TOGGL|MODE |     |     |
+   * `---------------------- '
+   */
+[4] = KEYMAP( /* NUMPAD SUPPLEMENT */
+  KC_NO,   KC_NO,   KC_NO,   KC_NO,   \
+  KC_NO,   KC_NO,   KC_NO,   KC_NO,   \
+  KC_NO,   KC_NO,   KC_NO,   KC_NO,   \
+  MU_TOG,  MU_MOD,  KC_NO,   TO(0)   \
+),
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+	return true;
+}
diff --git a/keyboards/ckeys/obelus/keymaps/default/readme.md b/keyboards/ckeys/obelus/keymaps/default/readme.md
new file mode 100644
index 0000000000..bac51fc043
--- /dev/null
+++ b/keyboards/ckeys/obelus/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for obelus
\ No newline at end of file
diff --git a/keyboards/ckeys/obelus/obelus.c b/keyboards/ckeys/obelus/obelus.c
new file mode 100644
index 0000000000..2905f0724d
--- /dev/null
+++ b/keyboards/ckeys/obelus/obelus.c
@@ -0,0 +1,28 @@
+#include "obelus.h"
+
+void matrix_init_kb(void) {
+	// put your keyboard start-up code here
+	// runs once when the firmware starts up
+	// Turn status LED on
+	DDRD |= (1<<6);
+	PORTD |= (1<<6);
+
+	matrix_init_user();
+}
+
+void matrix_scan_kb(void) {
+	// put your looping keyboard code here
+	// runs every cycle (a lot)
+	matrix_scan_user();
+}
+
+bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
+	// put your per-action keyboard code here
+	// runs for every action, just before processing by the firmware
+	return process_record_user(keycode, record);
+}
+
+void led_set_kb(uint8_t usb_led) {
+	// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+	led_set_user(usb_led);
+}
diff --git a/keyboards/ckeys/obelus/obelus.h b/keyboards/ckeys/obelus/obelus.h
new file mode 100644
index 0000000000..8444be897c
--- /dev/null
+++ b/keyboards/ckeys/obelus/obelus.h
@@ -0,0 +1,23 @@
+#ifndef OBELUS_H
+#define OBELUS_H
+
+#include "quantum.h"
+
+// This a shortcut to help you visually see your layout.
+// The following is an example using the Planck MIT layout
+// The first section contains all of the arguements
+// The second converts the arguments into a two-dimensional array
+#define KEYMAP( \
+    k00, k01, k02, k03, \
+    k10, k11, k12, k13, \
+    k20, k21, k22, k23, \
+    k30, k31, k32, k33 \
+) \
+{ \
+    { k00, k01, k02, k03 }, \
+    { k10, k11, k12, k13 }, \
+    { k20, k21, k22, k23 }, \
+    { k30, k31, k32, k33 } \
+}
+
+#endif
diff --git a/keyboards/ckeys/obelus/readme.md b/keyboards/ckeys/obelus/readme.md
new file mode 100644
index 0000000000..6767956bf9
--- /dev/null
+++ b/keyboards/ckeys/obelus/readme.md
@@ -0,0 +1,19 @@
+Obelus
+===
+
+[The Obelus](https://imgur.com/a/vj4LF) is designed to provide an easy platform to work with for people who are new to building keyboards. It is also especially useful as a QMK testbed, featuring support for a lot of the interesting features of QMK including audio, and a lot of spare pins broken out to headers for hacking away.
+
+Keyboard Maintaintainers: [Ethan Madden](https://github.com/jetpacktuxedo), [James Underwood](https://github.com/ju0)  
+Hardware Supported: Obelus  
+Hardware Availability: [C-Keys soldering workshops](https://ckeys.org/workshops/), [/u/MonkeyPlusPlus](https://www.reddit.com/user/monkeyplusplus)  
+
+Make example for this keyboard (after setting up your build environment):
+
+    make ckeys/obelus:default
+
+Or to make and flash:
+
+    make ckeys/obelus:default:dfu
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) and [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+
diff --git a/keyboards/ckeys/obelus/rules.mk b/keyboards/ckeys/obelus/rules.mk
new file mode 100644
index 0000000000..d999b118cb
--- /dev/null
+++ b/keyboards/ckeys/obelus/rules.mk
@@ -0,0 +1,68 @@
+# MCU name
+#MCU = at90usb1287
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+
+# Boot Section Size in *bytes*
+#   Teensy halfKay   512
+#   Teensy++ halfKay 1024
+#   Atmel DFU loader 4096
+#   LUFA bootloader  4096
+#   USBaspLoader     2048
+OPT_DEFS += -DBOOTLOADER_SIZE=4096
+
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no      # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = no        # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no            # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality on B7 by default
+MIDI_ENABLE = yes            # MIDI controls
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = yes           # Audio output on port C6
+FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches