Documentation: Updated KBDFans readmes (#14725)

Co-authored-by: Ryan <fauxpark@gmail.com>
This commit is contained in:
MechMerlin 2021-10-14 16:03:53 -07:00 committed by GitHub
parent e8dadf51ad
commit a827adeaae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 61 additions and 49 deletions

View file

@ -4,9 +4,9 @@
A compact 40% (12x4) ortholinear keyboard kit sold by KBDFans. A compact 40% (12x4) ortholinear keyboard kit sold by KBDFans.
Keyboard Maintainer: ![sevenseacat](https://github.com/sevenseacat) * Keyboard Maintainer: ![sevenseacat](https://github.com/sevenseacat)
Hardware Supported: KBD4x PCB * Hardware Supported: KBD4x PCB
Hardware Availability: https://kbdfans.cn/collections/diy-kit/products/kbd4x-custom-mechanical-keyboard-hot-swap-diy-kit * 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): Make example for this keyboard (after setting up your build environment):

View file

@ -2,11 +2,11 @@
![KBD66](https://i.imgur.com/qtLuL2o.jpg) ![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) * Keyboard Maintainer: [Alex](https://github.com/allo-world)
Hardware Supported: KBD66, ATmega32U4 * Hardware Supported: KBD66, ATmega32U4
Hardware Availability: [KBDFans](https://kbdfans.cn), [Massdrop](https://www.massdrop.com/buy/kbd66-mechanical-keyboard-kit?mode=guest_open) * 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): Make example for this keyboard (after setting up your build environment):

View file

@ -2,9 +2,11 @@
A 65% hot swap board with blocker and USB Type C port. A 65% hot swap board with blocker and USB Type C port.
Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) This PCB was replaced by the hotswap variants of the kbd67mkii
Hardware Supported: KBD67 Hotswap
Hardware Availability: [KBDFans](https://kbdfans.cn/products/coming-soon-kbd67-mechanical-keyboard-diy-kit) * 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): Make example for this keyboard (after setting up your build environment):

View file

@ -2,8 +2,7 @@
![Render](https://i.imgur.com/W8jBycQ.png) ![Render](https://i.imgur.com/W8jBycQ.png)
A simple 65% keyboard Solderable 65% PCB made originally for the KBD67mkii by ai03. For hotswap PCB firmware, please check the other directories.
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/) * Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/)
* Hardware Supported: KBD67 MKII Soldered PCB (Not hotswap) * Hardware Supported: KBD67 MKII Soldered PCB (Not hotswap)

View file

@ -1,6 +1,8 @@
# KBD67 Mk.II RGB V1 (Hotswap) # 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) * Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
* Hardware Supported: KBD67 Mk.II RGB V1 * Hardware Supported: KBD67 Mk.II RGB V1

View file

@ -2,6 +2,10 @@
A hotswap 65% keyboard with USB C, inswitch RGB, and ESD protection. 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) * Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
* Hardware Supported: KBD67 Mk.II RGB V2 * Hardware Supported: KBD67 Mk.II RGB V2
* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/) * Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)

View file

@ -2,6 +2,12 @@
A hotswap 65% keyboard with USB C, inswitch RGB, and ESD protection. 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) * Keyboard Maintainer: [moyi4681](https://github.com/moyi4681)
* Hardware Supported: KBD67 Mk.II RGB V3 * Hardware Supported: KBD67 Mk.II RGB V3
* Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/) * Hardware Availability: [kbdfans](https://kbdfans.myshopify.com/)

View file

@ -1,6 +1,6 @@
# KBD67 # 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". 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. 2. [HotSwap](hotswap/): Released in late 2018. Atmega32U4 hotswap single layout keyboard.
@ -8,12 +8,12 @@ A 65% keyboard sold in several variants.
4. [MKII](mkii_soldered/): Released in September 2019, designed by ai03. Atmega32u4 soldered keyboard. ESD Protected 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/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. **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) * 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 * Hardware Availability: KBDFans
Make examples for this keyboard (after setting up your build environment): Make examples for this keyboard (after setting up your build environment):
@ -24,5 +24,6 @@ Make examples for this keyboard (after setting up your build environment):
make kbdfans/kbd67/mkii_soldered:default make kbdfans/kbd67/mkii_soldered:default
make kbdfans/kbd67/mkiirgb/v1:default make kbdfans/kbd67/mkiirgb/v1:default
make kbdfans/kbd67/mkiirgb/v2: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). 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).

View file

@ -1,10 +1,10 @@
# KBD67 rev1 # 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) * Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
Hardware Supported: KBD67 PCB (Sometimes sold under the name "KBD65") * 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) * 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): Make example for this keyboard (after setting up your build environment):

View file

@ -1,10 +1,10 @@
# KBD67 rev2 # 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) * Keyboard Maintainer: [Vorror](https://github.com/vorror)
Hardware Supported: KBD67v2 PCB (Sometimes sold under the name "KBD65") * 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) * 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): Make example for this keyboard (after setting up your build environment):

View file

@ -2,9 +2,9 @@
A WKL Hot Swap Double USB C 60% A WKL Hot Swap Double USB C 60%
Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) * Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
Hardware Supported: KBD6x PCB * Hardware Supported: KBD6x PCB
Hardware Availability: [KBDFans](https://kbdfans.cn/products/kbd6x-wkl-hot-swap-60-double-type-c-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): Make example for this keyboard (after setting up your build environment):

View file

@ -1,11 +1,5 @@
# KBD75 # 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. 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) * **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)) * **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). * **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 example for this keyboard (after setting up your build environment):
make kbdfans/kbd75/rev1:default make kbdfans/kbd75/rev1:default

View file

@ -1,12 +1,10 @@
# KBD8X # KBD8X
![kbd8x](imgur.com image replace me!)
TKL Keyboard from KBDFans TKL Keyboard from KBDFans
Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) * Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
Hardware Supported: kbd8x * Hardware Supported: kbd8x
Hardware Availability: [KBDFans](https://kbdfans.cn/blogs/updates/kbd-8x-update-40) * Hardware Availability: [KBDFans](https://kbdfans.cn/blogs/updates/kbd-8x-update-40)
Make example for this keyboard (after setting up your build environment): Make example for this keyboard (after setting up your build environment):

View file

@ -4,9 +4,9 @@
A fairly typical TKL A fairly typical TKL
Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/) * Keyboard Maintainer: [ai03](https://github.com/ai03-2725) / [KBDfans](https://kbdfans.cn/)
Hardware Supported: KBD8X MKII PCB/case * Hardware Supported: KBD8X MKII PCB/case
Hardware Availability: [KBDfans](https://kbdfans.com/collections/90-kbd19x/products/gb-kbd8x-mkii-pcb) * 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): Make example for this keyboard (after setting up your build environment):

View file

@ -1,7 +1,5 @@
# KBDMINI # KBDMINI
![KBDMINI](imgur.com image replace me!)
* Keyboard Maintainer: [DZTECH](https://github.com/moyi4681) * Keyboard Maintainer: [DZTECH](https://github.com/moyi4681)
* Hardware Supported: KBDMINI * Hardware Supported: KBDMINI
* Hardware Availability: [KBDFans](https://kbdfans.cn/) * Hardware Availability: [KBDFans](https://kbdfans.cn/)