LFKeyboards Mini1800: refactor into revisions (#16260)

* fork Mini1800 into reva and revc versions

* update info.json

- apply friendly formatting
- update maintainer value

* update keymap rules.mk formatting

- align inline comments
- convert tabs to spaces

* align keymap rules.mk files to QMK template

* move common keymap rules.mk settings to revision level

* info.json: correct key sequence

* align revision rules.mk files to QMK template

* clean up revision rules.mk files

* add readme files for each revision

* correct USB Product string

* remove post_rules.mk files

The internal settings were commented out, so the files actually don't do anything.

* edit Bootloader instructions on main readme

* move non-assignment rules to post_rules.mk

* add inline comments for NKRO_ENABLE per fauxpark

keyboards/lfkeyboards/mini1800/config.h

@@ -23,7 +23,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define PRODUCT_ID      0x6060
 #define DEVICE_VER      0x0001
 #define MANUFACTURER    LFKeyboards
-#define PRODUCT         LFK87
+#define PRODUCT         Mini1800
 
 #define DIODE_DIRECTION COL2ROW
 

keyboards/lfkeyboards/mini1800/keymaps/ca178858/rules.mk

@@ -1,45 +1 @@
-BOOTMAGIC_ENABLE = no       # Enable Bootmagic Lite
-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
-NKRO_ENABLE = yes
-BACKLIGHT_ENABLE = yes           # Enable keyboard backlight functionality
-MIDI_ENABLE = no                # MIDI controls
-AUDIO_ENABLE = yes              # Audio output on port C6
-UNICODE_ENABLE = no             # Unicode
-BLUETOOTH_ENABLE = no           # Enable Bluetooth with the Adafruit EZ-Key HID
-RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
-SLEEP_LED_ENABLE = yes
 TAP_DANCE_ENABLE = yes
-
-ISSI_ENABLE = yes			# If the I2C pullup resistors aren't install this must be disabled
-WATCHDOG_ENABLE = yes		# Resets keyboard if matrix_scan isn't run every 250ms
-
-
-
-ifeq ($(strip $(ISSI_ENABLE)), yes)
-    TMK_COMMON_DEFS += -DISSI_ENABLE
-endif
-
-ifeq ($(strip $(WATCHDOG_ENABLE)), yes)
-    TMK_COMMON_DEFS += -DWATCHDOG_ENABLE
-endif
-
-
-# # Set the LFK78 hardware version. This is defined in rules.mk, but can be overidden here if desired
-# #
-# # RevB - first public release, uses atmega32u4, has audio, ISSI matrix split between RGB and backlight
-# # RevC/D - at90usb1286, no audio, ISSI device 0 is backlight, 4 is RGB
-# #
-# # Set to B, C or D
-# LFK_REV = D
-
-# ifeq ($(LFK_REV), B)
-# 	MCU = atmega32u4
-# else
-# 	MCU = at90usb1286
-# endif
-# OPT_DEFS += -DLFK_REV_$(LFK_REV)
-# OPT_DEFS += -DUSB_PRODUCT=\"LFK_Rev$(LFK_REV)\"

keyboards/lfkeyboards/mini1800/keymaps/default/rules.mk

@@ -1,40 +0,0 @@
-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 = yes
-BACKLIGHT_ENABLE = yes           # Enable keyboard backlight functionality
-AUDIO_ENABLE = yes              # Audio output
-RGBLIGHT_ENABLE = yes           # Enable RGB underlight
-RGBLIGHT_CUSTOM_DRIVER = yes    # RGB code is implemented in lefkeyboards, not WS2812
-SLEEP_LED_ENABLE = yes
-
-ISSI_ENABLE = yes			# If the I2C pullup resistors aren't install this must be disabled
-WATCHDOG_ENABLE = yes		# Resets keyboard if matrix_scan isn't run every 250ms
-
-
-ifeq ($(strip $(ISSI_ENABLE)), yes)
-    TMK_COMMON_DEFS += -DISSI_ENABLE
-endif
-
-ifeq ($(strip $(WATCHDOG_ENABLE)), yes)
-    TMK_COMMON_DEFS += -DWATCHDOG_ENABLE
-endif
-
-
-# # Set the LFK78 hardware version. This is defined in rules.mk, but can be overidden here if desired
-# #
-# # RevB - first public release, uses atmega32u4, has audio, ISSI matrix split between RGB and backlight
-# # RevC/D - at90usb1286, no audio, ISSI device 0 is backlight, 4 is RGB
-# #
-# # Set to B, C or D
-# LFK_REV = D
-
-# ifeq ($(LFK_REV), B)
-# 	MCU = atmega32u4
-# else
-# 	MCU = at90usb1286
-# endif
-# OPT_DEFS += -DLFK_REV_$(LFK_REV)
-# OPT_DEFS += -DUSB_PRODUCT=\"LFK_Rev$(LFK_REV)\"

keyboards/lfkeyboards/mini1800/post_rules.mk

@@ -1,9 +0,0 @@
-ifeq ($(LFK_REV), A)
-    MCU = at90usb1286
-else
-    MCU = at90usb646
-endif
-
-ifeq ($(strip $(ISSI_ENABLE)), yes)
-    # TMK_COMMON_DEFS += -DISSI_ENABLE
-endif

keyboards/lfkeyboards/mini1800/readme.md

@@ -1,12 +1,26 @@
-Mini1800
-===
+# Mini1800
 
-Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)  
-Hardware Supported: Mini1800  
-Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
+* Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
+* Hardware Supported:
+  * [Mini1800 RevA](reva/) - Green PCB with AT90USB1286
+  * [Mini1800 RevC](revc/) - Black PCB with AT90USB646; first public release
+* Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
 
 Make example for this keyboard (after setting up your build environment):
 
-    make lfkeyboards/mini1800:default
+    make lfkeyboards/mini1800/reva:default
+    make lfkeyboards/mini1800/revc:default
 
-See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. 
+Flashing example for this keyboard:
+
+    make lfkeyboards/mini1800/reva:default:flash
+    make lfkeyboards/mini1800/revc:default:flash
+
+## Bootloader
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Physical reset button**: Briefly press the button on the bottom of the PCB (between Q and W keys)
+* **Keycode in keymap**: Press the key mapped to `RESET` if it is available (`Fn`+`Right Shift`, then tap `Enter` by default)
+
+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).

keyboards/lfkeyboards/mini1800/reva/post_rules.mk

@@ -0,0 +1,7 @@
+ifeq ($(strip $(ISSI_ENABLE)), yes)
+    TMK_COMMON_DEFS += -DISSI_ENABLE
+endif
+
+ifeq ($(strip $(WATCHDOG_ENABLE)), yes)
+    TMK_COMMON_DEFS += -DWATCHDOG_ENABLE
+endif

keyboards/lfkeyboards/mini1800/reva/readme.md

@@ -0,0 +1,22 @@
+# Mini1800 RevA
+
+* Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
+* Hardware Supported: Mini1800 RevA (Green PCB with AT90USB1286)
+* Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make lfkeyboards/mini1800/reva:default
+
+Flashing example for this keyboard:
+
+    make lfkeyboards/mini1800/reva:default:flash
+
+## Bootloader
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Physical reset button**: Briefly press the button on the bottom of the PCB (between Q and W keys)
+* **Keycode in keymap**: Press the key mapped to `RESET` if it is available (`Fn`+`Right Shift`, then tap `Enter` by default)
+
+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).

keyboards/lfkeyboards/mini1800/reva/rules.mk

@@ -0,0 +1,29 @@
+# MCU name
+MCU = at90usb1286
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# 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 = yes           # Enable N-Key Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+AUDIO_ENABLE = yes          # Audio output
+
+# RGB code is implemented in lfkeyboards, not WS2812
+RGBLIGHT_CUSTOM_DRIVER = yes
+BACKLIGHT_DRIVER = custom
+SLEEP_LED_ENABLE = yes
+
+ISSI_ENABLE = yes           # If the I2C pullup resistors aren't install this must be disabled
+WATCHDOG_ENABLE = yes       # Resets keyboard if matrix_scan isn't run every 250ms
+
+# Extra source files for IS3731 lighting
+SRC = TWIlib.c issi.c lighting.c

keyboards/lfkeyboards/mini1800/revc/post_rules.mk

@@ -0,0 +1,7 @@
+ifeq ($(strip $(ISSI_ENABLE)), yes)
+    TMK_COMMON_DEFS += -DISSI_ENABLE
+endif
+
+ifeq ($(strip $(WATCHDOG_ENABLE)), yes)
+    TMK_COMMON_DEFS += -DWATCHDOG_ENABLE
+endif

keyboards/lfkeyboards/mini1800/revc/readme.md

@@ -0,0 +1,24 @@
+# Mini1800 RevC
+
+The first public release of the Mini1800.
+
+* Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
+* Hardware Supported: Mini1800 RevC (Black PCB with AT90USB646)
+* Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make lfkeyboards/mini1800/revc:default
+
+Flashing example for this keyboard:
+
+    make lfkeyboards/mini1800/revc:default:flash
+
+## Bootloader
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Physical reset button**: Briefly press the button on the bottom of the PCB (between Q and W keys)
+* **Keycode in keymap**: Press the key mapped to `RESET` if it is available (`Fn`+`Right Shift`, then tap `Enter` by default)
+
+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).

keyboards/lfkeyboards/mini1800/revc/rules.mk

@@ -0,0 +1,29 @@
+# MCU name
+MCU = at90usb646
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# 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 = yes           # Enable N-Key Rollover
+BACKLIGHT_ENABLE = yes      # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+AUDIO_ENABLE = yes          # Audio output
+
+# RGB code is implemented in lfkeyboards, not WS2812
+RGBLIGHT_CUSTOM_DRIVER = yes
+BACKLIGHT_DRIVER = custom
+SLEEP_LED_ENABLE = yes
+
+ISSI_ENABLE = yes           # If the I2C pullup resistors aren't install this must be disabled
+WATCHDOG_ENABLE = yes       # Resets keyboard if matrix_scan isn't run every 250ms
+
+# Extra source files for IS3731 lighting
+SRC = TWIlib.c issi.c lighting.c

keyboards/lfkeyboards/mini1800/rules.mk

@@ -1,19 +0,0 @@
-# Set the LFK87 hardware version.
-#
-# RevA - Green PCB. at90usb1286 Only 3 exist
-# RevB - We don't talk about RevB
-# RevC - Black PCB. at90usb646 First public release
-#
-# Set to A or C
-LFK_REV = C
-
-BOOTLOADER = atmel-dfu
-OPT_DEFS += -DLFK_TKL_REV_$(LFK_REV)
-
-# Extra source files for IS3731 lighting
-SRC = TWIlib.c issi.c lighting.c
-
-# Build Options
-#   change yes to no to disable
-#
-BACKLIGHT_DRIVER = custom