From a827adeaaedfbefc504c0f909a507706948cd40f Mon Sep 17 00:00:00 2001 From: MechMerlin <30334081+mechmerlin@users.noreply.github.com> Date: Thu, 14 Oct 2021 16:03:53 -0700 Subject: [PATCH] Documentation: Updated KBDFans readmes (#14725) Co-authored-by: Ryan --- keyboards/kbdfans/kbd4x/readme.md | 6 +++--- keyboards/kbdfans/kbd66/readme.md | 8 ++++---- keyboards/kbdfans/kbd67/hotswap/readme.md | 8 +++++--- .../kbdfans/kbd67/mkii_soldered/readme.md | 3 +-- keyboards/kbdfans/kbd67/mkiirgb/v1/readme.md | 4 +++- keyboards/kbdfans/kbd67/mkiirgb/v2/readme.md | 4 ++++ keyboards/kbdfans/kbd67/mkiirgb/v3/readme.md | 6 ++++++ keyboards/kbdfans/kbd67/readme.md | 19 ++++++++++--------- keyboards/kbdfans/kbd67/rev1/readme.md | 8 ++++---- keyboards/kbdfans/kbd67/rev2/readme.md | 8 ++++---- keyboards/kbdfans/kbd6x/readme.md | 6 +++--- keyboards/kbdfans/kbd75/readme.md | 14 ++++++++------ keyboards/kbdfans/kbd8x/readme.md | 8 +++----- keyboards/kbdfans/kbd8x_mk2/readme.md | 6 +++--- keyboards/kbdfans/kbdmini/readme.md | 2 -- 15 files changed, 61 insertions(+), 49 deletions(-) diff --git a/keyboards/kbdfans/kbd4x/readme.md b/keyboards/kbdfans/kbd4x/readme.md index 2e2a29290fa..6220fe82496 100644 --- a/keyboards/kbdfans/kbd4x/readme.md +++ b/keyboards/kbdfans/kbd4x/readme.md @@ -4,9 +4,9 @@ A compact 40% (12x4) ortholinear keyboard kit sold by KBDFans. -Keyboard Maintainer: ![sevenseacat](https://github.com/sevenseacat) -Hardware Supported: KBD4x PCB -Hardware Availability: https://kbdfans.cn/collections/diy-kit/products/kbd4x-custom-mechanical-keyboard-hot-swap-diy-kit +* Keyboard Maintainer: ![sevenseacat](https://github.com/sevenseacat) +* Hardware Supported: KBD4x PCB +* Hardware Availability: https://kbdfans.cn/collections/diy-kit/products/kbd4x-custom-mechanical-keyboard-hot-swap-diy-kit Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd66/readme.md b/keyboards/kbdfans/kbd66/readme.md index a2e5de0157f..8979135c3fc 100644 --- a/keyboards/kbdfans/kbd66/readme.md +++ b/keyboards/kbdfans/kbd66/readme.md @@ -2,11 +2,11 @@ ![KBD66](https://i.imgur.com/qtLuL2o.jpg) -A 65% keyboard from KBDFans. +A 66 key keyboard from KBDFans modeled after the FC660m. -Keyboard Maintainer: [Alex](https://github.com/allo-world) -Hardware Supported: KBD66, ATmega32U4 -Hardware Availability: [KBDFans](https://kbdfans.cn), [Massdrop](https://www.massdrop.com/buy/kbd66-mechanical-keyboard-kit?mode=guest_open) +* Keyboard Maintainer: [Alex](https://github.com/allo-world) +* Hardware Supported: KBD66, ATmega32U4 +* Hardware Availability: [KBDFans](https://kbdfans.cn), [Massdrop](https://www.massdrop.com/buy/kbd66-mechanical-keyboard-kit?mode=guest_open) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd67/hotswap/readme.md b/keyboards/kbdfans/kbd67/hotswap/readme.md index bb64c03e3c1..49a74f109aa 100644 --- a/keyboards/kbdfans/kbd67/hotswap/readme.md +++ b/keyboards/kbdfans/kbd67/hotswap/readme.md @@ -2,9 +2,11 @@ A 65% hot swap board with blocker and USB Type C port. -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: KBD67 Hotswap -Hardware Availability: [KBDFans](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit) +This PCB was replaced by the hotswap variants of the kbd67mkii + +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: KBD67 Hotswap +* Hardware Availability: [KBDFans](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd67/mkii_soldered/readme.md b/keyboards/kbdfans/kbd67/mkii_soldered/readme.md index d864c9e99b5..deea30f4fb6 100644 --- a/keyboards/kbdfans/kbd67/mkii_soldered/readme.md +++ b/keyboards/kbdfans/kbd67/mkii_soldered/readme.md @@ -2,8 +2,7 @@ ![Render](https://i.imgur.com/W8jBycQ.png) -A simple 65% keyboard -This is for the solderable PCB for the MKII. For hotswap PCB firmware, please check the other directories. +Solderable 65% PCB made originally for the KBD67mkii by ai03. 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) diff --git a/keyboards/kbdfans/kbd67/mkiirgb/v1/readme.md b/keyboards/kbdfans/kbd67/mkiirgb/v1/readme.md index 94550ef3200..a6d8578d7ff 100644 --- a/keyboards/kbdfans/kbd67/mkiirgb/v1/readme.md +++ b/keyboards/kbdfans/kbd67/mkiirgb/v1/readme.md @@ -1,6 +1,8 @@ # KBD67 Mk.II RGB V1 (Hotswap) -A hotswap 65% keyboard with USB C and inswitch RGB. +An hotswap 65% keyboard with USB C and inswitch RGB. + +This was released along with the kbd67mkii keyboard that featured a top mount design, and brass weight. * Keyboard Maintainer: [moyi4681](https://github.com/moyi4681) * Hardware Supported: KBD67 Mk.II RGB V1 diff --git a/keyboards/kbdfans/kbd67/mkiirgb/v2/readme.md b/keyboards/kbdfans/kbd67/mkiirgb/v2/readme.md index 57683caab9d..af25471fe5e 100644 --- a/keyboards/kbdfans/kbd67/mkiirgb/v2/readme.md +++ b/keyboards/kbdfans/kbd67/mkiirgb/v2/readme.md @@ -2,6 +2,10 @@ A hotswap 65% keyboard with USB C, inswitch RGB, and ESD protection. +Originally sold as a replacement PCB for the kbd67mkii when the V1 PCB failed. + +It has since been sold along with the D64 and KBD67 Lite R1/R2. + * Keyboard Maintainer: [moyi4681](https://github.com/moyi4681) * Hardware Supported: KBD67 Mk.II RGB V2 * Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/) diff --git a/keyboards/kbdfans/kbd67/mkiirgb/v3/readme.md b/keyboards/kbdfans/kbd67/mkiirgb/v3/readme.md index d62d4a517c4..7442df9c6e3 100644 --- a/keyboards/kbdfans/kbd67/mkiirgb/v3/readme.md +++ b/keyboards/kbdfans/kbd67/mkiirgb/v3/readme.md @@ -2,6 +2,12 @@ A hotswap 65% keyboard with USB C, inswitch RGB, and ESD protection. +Originally sold as a replacement to the V2 as it offered a much simpler firmware flashing experience for customers. This board expects `.bin` files. + +As of 10/2021 this board has no visible markings differentiating it from the previous V2. + +It has since been sold with the KBD67Lite R2, D64, and Blade 65. + * Keyboard Maintainer: [moyi4681](https://github.com/moyi4681) * Hardware Supported: KBD67 Mk.II RGB V3 * Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/) diff --git a/keyboards/kbdfans/kbd67/readme.md b/keyboards/kbdfans/kbd67/readme.md index 2f5d10fa079..f3aed999a1e 100644 --- a/keyboards/kbdfans/kbd67/readme.md +++ b/keyboards/kbdfans/kbd67/readme.md @@ -1,19 +1,19 @@ # KBD67 -A 65% keyboard sold in several variants. +A 65% keyboard sold in several variants supporting KBDFan's different 65% lineups each with their own different revisions. -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. +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. +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. - +6. [MKII RGB V2*](mkiirgb/v3/): Released in March 2021. Atmega32u4 hotswap board. ESD Protected. Uses LUFA bootloader and different inswitch RGB implementation. No visible markings differentiating it from the previous V2. **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, mkii, mkiirgb v1, mkiirgb v2 +* Hardware Supported: KBD67 rev1, rev2, hotswap, mkii, mkiirgb v1, mkiirgb v2, etc. * Hardware Availability: KBDFans Make examples for this keyboard (after setting up your build environment): @@ -21,8 +21,9 @@ 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/mkii_soldered:default - make kbdfans/kbd67/mkiirgb/v1:default - make kbdfans/kbd67/mkiirgb/v2:default + make kbdfans/kbd67/mkii_soldered:default + make kbdfans/kbd67/mkiirgb/v1:default + make kbdfans/kbd67/mkiirgb/v2:default + make kbdfans/kbd67/mkiirgb/v3: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). diff --git a/keyboards/kbdfans/kbd67/rev1/readme.md b/keyboards/kbdfans/kbd67/rev1/readme.md index 1d92a41f7c4..0e9c66b2445 100644 --- a/keyboards/kbdfans/kbd67/rev1/readme.md +++ b/keyboards/kbdfans/kbd67/rev1/readme.md @@ -1,10 +1,10 @@ # KBD67 rev1 -65% keyboard with blocker. +65% keyboard with RGB underglow originally sold for the Tofu 65 and Tada 68 keyboards. -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: KBD67 PCB (Sometimes sold under the name "KBD65") -Hardware Availability: KBDFans [Keyboard Kit](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit), [PCB](https://kbdfans.cn/collections/65/products/kbd65-65-custom-mechanical-keyboard-pcb) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: KBD67 PCB (Sometimes sold under the name "KBD65") +* Hardware Availability: KBDFans [Keyboard Kit](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit), [PCB](https://kbdfans.cn/collections/65/products/kbd65-65-custom-mechanical-keyboard-pcb) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd67/rev2/readme.md b/keyboards/kbdfans/kbd67/rev2/readme.md index 0909f781d06..5181de3a992 100644 --- a/keyboards/kbdfans/kbd67/rev2/readme.md +++ b/keyboards/kbdfans/kbd67/rev2/readme.md @@ -1,10 +1,10 @@ # KBD67 rev2 -65% pcb with blocker. Revision 2 (Manufactured after 05/01/19). +65% keyboard with RGB underglow originally sold for the Tofu 65 and Tada 68 keyboards. -Keyboard Maintainer: [Vorror](https://github.com/vorror) -Hardware Supported: KBD67v2 PCB (Sometimes sold under the name "KBD65") -Hardware Availability: KBDFans [Keyboard Kit](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit), [PCB](https://kbdfans.cn/collections/65/products/kbd65-65-custom-mechanical-keyboard-pcb) +* Keyboard Maintainer: [Vorror](https://github.com/vorror) +* Hardware Supported: KBD67v2 PCB (Sometimes sold under the name "KBD65") +* Hardware Availability: KBDFans [Keyboard Kit](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit), [PCB](https://kbdfans.cn/collections/65/products/kbd65-65-custom-mechanical-keyboard-pcb) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd6x/readme.md b/keyboards/kbdfans/kbd6x/readme.md index 1728c8c21bf..1fd1d2848a7 100644 --- a/keyboards/kbdfans/kbd6x/readme.md +++ b/keyboards/kbdfans/kbd6x/readme.md @@ -2,9 +2,9 @@ A WKL Hot Swap Double USB C 60% -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: KBD6x PCB -Hardware Availability: [KBDFans](https://kbdfans.cn/products/kbd6x-wkl-hot-swap-60-double-type-c-pcb) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: KBD6x PCB +* Hardware Availability: [KBDFans](https://kbdfans.cn/products/kbd6x-wkl-hot-swap-60-double-type-c-pcb) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd75/readme.md b/keyboards/kbdfans/kbd75/readme.md index c2bbdbb8b71..b7bf379c109 100644 --- a/keyboards/kbdfans/kbd75/readme.md +++ b/keyboards/kbdfans/kbd75/readme.md @@ -1,11 +1,5 @@ # KBD75 -Keyboard Maintainer: QMK Community -Hardware Supported: KBD75 PCB rev 1 and 2 -Hardware Availability: -* https://kbdfans.com/collections/75-diy-kit/products/kbd75-keyboard-set -* https://kbdfans.com/collections/75-diy-kit/products/kbd75v2-custom-keyboard-diy-kit - The KBD75 was sold through various rounds, with various PCB changes between them. * **Round 1 (2017)**: Black PCB - Bootmapper Client, atmega32a MCU (Use [Winkeyless.kr B.mini](../../winkeyless/bmini/) firmware) @@ -14,6 +8,14 @@ The KBD75 was sold through various rounds, with various PCB changes between them * **Round 6 (2019)**: White PCB with USB C - QMK Firmware, atmega32u4 MCU (Use KBD75 rev1 or rev2(with numpad support)) * **V2 (2019-)**: Same as **Round 6** (above). +**Firmware files are SPECIFIC to each board. Firmware files from one, will not work on the other.** + +* Keyboard Maintainer: QMK Community +* Hardware Supported: KBD75 PCB rev 1 and 2 +* Hardware Availability: + * https://kbdfans.com/collections/75-diy-kit/products/kbd75-keyboard-set + * https://kbdfans.com/collections/75-diy-kit/products/kbd75v2-custom-keyboard-diy-kit + Make example for this keyboard (after setting up your build environment): make kbdfans/kbd75/rev1:default diff --git a/keyboards/kbdfans/kbd8x/readme.md b/keyboards/kbdfans/kbd8x/readme.md index 9f8555560ab..d95d51533d3 100644 --- a/keyboards/kbdfans/kbd8x/readme.md +++ b/keyboards/kbdfans/kbd8x/readme.md @@ -1,12 +1,10 @@ # KBD8X -![kbd8x](imgur.com image replace me!) - TKL Keyboard from KBDFans -Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) -Hardware Supported: kbd8x -Hardware Availability: [KBDFans](https://kbdfans.cn/blogs/updates/kbd-8x-update-40) +* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +* Hardware Supported: kbd8x +* Hardware Availability: [KBDFans](https://kbdfans.cn/blogs/updates/kbd-8x-update-40) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbd8x_mk2/readme.md b/keyboards/kbdfans/kbd8x_mk2/readme.md index fbd65046096..d20a17da4d1 100644 --- a/keyboards/kbdfans/kbd8x_mk2/readme.md +++ b/keyboards/kbdfans/kbd8x_mk2/readme.md @@ -4,9 +4,9 @@ A fairly typical TKL -Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/) -Hardware Supported: KBD8X MKII PCB/case -Hardware Availability: [KBDfans](https://kbdfans.com/collections/90-kbd19x/products/gb-kbd8x-mkii-pcb) +* Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/) +* Hardware Supported: KBD8X MKII PCB/case +* Hardware Availability: [KBDfans](https://kbdfans.com/collections/90-kbd19x/products/gb-kbd8x-mkii-pcb) Make example for this keyboard (after setting up your build environment): diff --git a/keyboards/kbdfans/kbdmini/readme.md b/keyboards/kbdfans/kbdmini/readme.md index 5d5ebe2a7a0..8b5e0478d38 100644 --- a/keyboards/kbdfans/kbdmini/readme.md +++ b/keyboards/kbdfans/kbdmini/readme.md @@ -1,7 +1,5 @@ # KBDMINI -![KBDMINI](imgur.com image replace me!) - * Keyboard Maintainer: [DZTECH](https://github.com/moyi4681) * Hardware Supported: KBDMINI * Hardware Availability: [KBDFans](https://kbdfans.cn/)