Browse Source

KBD67 MKII Notes Update (#7824)

* add readme to each of the mkii versions

* update the most parent of kbd67 readmes to have history of the new versions

* fix up the parent readme for the two types of boards

* Update keyboards/kbdfans/kbd67/mkiirgb/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update keyboards/kbdfans/kbd67/mkiirgb/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update keyboards/kbdfans/kbd67/mkiirgb/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update keyboards/kbdfans/kbd67/mkiirgb/readme.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* fixup readmes

Co-authored-by: fauxpark <fauxpark@gmail.com>
MechMerlin 5 years ago
parent
commit
886eb98e2a

+ 3 - 3
keyboards/kbdfans/kbd67/mkii_soldered/readme.md

@@ -5,9 +5,9 @@
 A simple 65% keyboard
 This is for the solderable PCB for the MKII. For hotswap PCB firmware, please check the other directories.
 
-Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/)  
-Hardware Supported: KBD67 MKII Soldered PCB (Not hotswap)
-Hardware Availability: KBDfans
+* Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/)
+* Hardware Supported: KBD67 MKII Soldered PCB (Not hotswap)
+* Hardware Availability: KBDfans
 
 Make example for this keyboard (after setting up your build environment):
 

+ 10 - 5
keyboards/kbdfans/kbd67/mkiirgb/readme.md

@@ -1,14 +1,19 @@
-# KBD67 Mk.II RGB
+# KBD67 Mk.II RGB (Hotswap)
 
 A customizable 65% RGB keyboard.
 
-Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)  
-Hardware Supported: KBD67 Mk.II RGB  
-Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
+* Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: KBD67 Mk.II RGB V1 and V2
+* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
 
+There are two versions of the KBD67 MKII RGB. Please use the appropriate firmware for your board. 
+
+* V1: STM32F303 (Arm), takes `.bin` files
+* V2: ATmega32U4 (AVR), takes `.hex` files
 
 Make example for this keyboard (after setting up your build environment):
 
-    make kbdfans/kbd67/mkiirgb:default
+    make kbdfans/kbd67/mkiirgb/v1:default # Arm (STM32F303)
+    make kbdfans/kbd67/mkiirgb/v2:default # AVR (ATmega32U4)
 
 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).

+ 13 - 0
keyboards/kbdfans/kbd67/mkiirgb/v1/readme.md

@@ -0,0 +1,13 @@
+# KBD67 Mk.II RGB V1 (Hotswap)
+
+A hotswap 65% keyboard with USB C and inswitch RGB.
+
+* Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: KBD67 Mk.II RGB V1
+* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make kbdfans/kbd67/mkiirgb/v1: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).

+ 13 - 0
keyboards/kbdfans/kbd67/mkiirgb/v2/readme.md

@@ -0,0 +1,13 @@
+# KBD67 Mk.II RGB V2 (Hotswap)
+
+A hotswap 65% keyboard with USB C, inswitch RGB, and ESD protection.
+
+* Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: KBD67 Mk.II RGB V2
+* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make kbdfans/kbd67/mkiirgb/v2: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).

+ 15 - 9
keyboards/kbdfans/kbd67/readme.md

@@ -1,22 +1,28 @@
 # KBD67
 
-A 65% keyboard sold in four variants. 
-1. Rev1: Typical keyboard that had to be soldered together, supporting multiple layouts. The rev1 PCB is sold under the name "KBD65".  
-2. HotSwap: Released in late 2018, Hotswap single layout keyboard. 
-3. Rev2: Released in April/May 2019, the Rev2 also needs to be soldered together and supports multiple layouts. 
-4. MKII RGB: Released in September 2019. ARM powered hotswap board. 
+A 65% keyboard sold in several variants. 
+
+1. [Rev1](rev1/): Released in early 2018. Atmega32u4 soldered keyboard. Sold under the name "KBD65".  
+2. [HotSwap](hotswap/): Released in late 2018. Atmega32U4 hotswap single layout keyboard. 
+3. [Rev2](rev2/): Released in April/May 2019. Atmega32u4 soldered keyboard.
+4. [MKII](mkii_soldered/): Released in September 2019, designed by ai03. Atmega32u4 soldered keyboard. ESD Protected
+5. [MKII RGB V1](mkiirgb/v1/): Released in September 2019. Arm hotswap board. 
+6. [MKII RGB V2](mkiirgb/v2/): Released in December 2019. Atmega32u4 hotswap board. ESD Protected.
+
 
  **Firmware files are SPECIFIC to each board. Firmware files from one, will not work on the other.** Please use the `.hex` or `.bin` appropriate for your board.
 
-Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin), [moyi4681](https://github.com/moyi4681)  
-Hardware Supported: KBD67 rev1, rev2, hotswap, mkiirgb  
-Hardware Availability: KBDFans  
+* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin), [moyi4681](https://github.com/moyi4681)
+* Hardware Supported: KBD67 rev1, rev2, hotswap, mkii, mkiirgb v1, mkiirgb v2
+* Hardware Availability: KBDFans
 
 Make examples for this keyboard (after setting up your build environment):
 
     make kbdfans/kbd67/rev1:default
     make kbdfans/kbd67/rev2:default
     make kbdfans/kbd67/hotswap:default
-    make kbdfans/kbd67/mkiirgb:default  
+    make kbdfans/kbd67/mkii_soldered:default 
+    make kbdfans/kbd67/mkiirgb/v1:default  
+    make kbdfans/kbd67/mkiirgb/v2: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).