From 7d60a141a25526d94bb28015eb08bbe27c0a88cd Mon Sep 17 00:00:00 2001
From: James Young <18669334+noroadsleft@users.noreply.github.com>
Date: Sun, 17 Apr 2022 12:53:59 -0700
Subject: Anne Pro 2 Refactor (#16864)

* move RGB Matrix rules to keyboard level

* move PERMISSIVE_HOLD config to keyboard level

* annepro2.c: convert tabs to spaces

* refactor rules.mk files

Reformats each version's `rules.mk` file to be arranged more similarly to those of the rest of the keyboards in QMK.

No logic change.

* annepro2.c: allow compilation without RGB Matrix

Wraps the `led_enabled` definition and the `KC_AP_RGB_*` keycodes in `#ifdef RGB_MATRIX_ENABLE`, allowing successful compilation if the user sets `RGB_MATRIX_ENABLE = no`.

* rework readme files

Reworks the main `readme.md` file to be more friendly to GitHub viewing, and removes the single-line version-specific readme files (exposes the main readme to QMK Configurator users).

* info.json: update maintainer value

* info.json: apply friendly formatting
---
 keyboards/annepro2/c15/config.h  |  3 +++
 keyboards/annepro2/c15/readme.md |  1 -
 keyboards/annepro2/c15/rules.mk  | 52 ++++++++++++++++++++++++----------------
 3 files changed, 35 insertions(+), 21 deletions(-)
 delete mode 100644 keyboards/annepro2/c15/readme.md

(limited to 'keyboards/annepro2/c15')

diff --git a/keyboards/annepro2/c15/config.h b/keyboards/annepro2/c15/config.h
index 012b412dc9..ff92aeea8e 100644
--- a/keyboards/annepro2/c15/config.h
+++ b/keyboards/annepro2/c15/config.h
@@ -46,3 +46,6 @@
 
 #define MATRIX_COL_PINS \
     { C4, C5, B10, B11, C0, A15, A8, A10, A11, A12, A13, A14, B2, B3 }
+
+// Obins stock firmware has something similar to this already enabled, but disabled by default in QMK
+#define PERMISSIVE_HOLD
diff --git a/keyboards/annepro2/c15/readme.md b/keyboards/annepro2/c15/readme.md
deleted file mode 100644
index 5fadb73909..0000000000
--- a/keyboards/annepro2/c15/readme.md
+++ /dev/null
@@ -1 +0,0 @@
-AnnePro2, ANSI C15 version.
diff --git a/keyboards/annepro2/c15/rules.mk b/keyboards/annepro2/c15/rules.mk
index 5cef8b8a87..2c518b6339 100644
--- a/keyboards/annepro2/c15/rules.mk
+++ b/keyboards/annepro2/c15/rules.mk
@@ -1,12 +1,3 @@
-# Anne Pro 2
-SRC = \
-	matrix.c \
-	annepro2_ble.c \
-	ap2_led.c \
-	protocol.c \
-	rgb_driver.c \
-	config_led.c
-
 # MCU
 MCU = cortex-m0plus
 ARMV = 6
@@ -18,23 +9,44 @@ MCU_STARTUP = ht32f523xx
 
 BOARD = ANNEPRO2_C15
 
-# Options
+# Bootloader selection
+BOOTLOADER = custom
+PROGRAM_CMD = annepro2_tools --boot $(BUILD_DIR)/$(TARGET).bin
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # 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 = no            # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
+AUDIO_ENABLE = no           # Audio output
+
+# Custom RGB matrix handling
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = custom
 
 # Keys
 CUSTOM_MATRIX = lite
-NKRO_ENABLE = no
-MOUSEKEY_ENABLE = no
-EXTRAKEY_ENABLE = yes
 KEY_LOCK_ENABLE = no
-LAYOUTS = 60_ansi
 
-# Other featues
-BOOTMAGIC_ENABLE = no
-CONSOLE_ENABLE = no
-COMMAND_ENABLE = no
+# Other features
 RAW_ENABLE = no
 MIDI_ENABLE = no
 VIRTSER_ENABLE = no
 COMBO_ENABLE = no
-BOOTLOADER = custom
-PROGRAM_CMD = annepro2_tools --boot $(BUILD_DIR)/$(TARGET).bin
+
+LAYOUTS = 60_ansi
+
+# Anne Pro 2
+SRC = \
+	matrix.c \
+	annepro2_ble.c \
+	ap2_led.c \
+	protocol.c \
+	rgb_driver.c \
+	config_led.c
-- 
cgit v1.2.3