diff options
| author | Joel Challis <git@zvecr.com> | 2021-08-26 16:53:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-26 16:53:24 +0100 |
| commit | 87cdb1cf9a89a702f0c4286d4260fc84b18ae042 (patch) | |
| tree | 948cbe686ee52b222ef3e4818c19260997bdbfb1 | |
| parent | 48d0ad28e789abae0413002f9dbda38f1a82924a (diff) | |
| download | qmk_firmware-87cdb1cf9a89a702f0c4286d4260fc84b18ae042.tar.gz qmk_firmware-87cdb1cf9a89a702f0c4286d4260fc84b18ae042.zip | |
Update readme files (#14172)
25 files changed, 74 insertions, 79 deletions
diff --git a/keyboards/kprepublic/bm16a/readme.md b/keyboards/kprepublic/bm16a/readme.md index 8d43b7014..b1c111b74 100644 --- a/keyboards/kprepublic/bm16a/readme.md +++ b/keyboards/kprepublic/bm16a/readme.md | |||
| @@ -4,12 +4,12 @@ | |||
| 4 | 4 | ||
| 5 | A 16 key macropad, with USB C, RGB underglow and backlight. | 5 | A 16 key macropad, with USB C, RGB underglow and backlight. |
| 6 | 6 | ||
| 7 | Keyboard Maintainer: QMK Community | 7 | * Keyboard Maintainer: QMK Community |
| 8 | Hardware Supported: The PCBs, controllers supported | 8 | * Hardware Supported: The PCBs, controllers supported |
| 9 | Hardware Availability: [KPrepublic](https://kprepublic.com/products/bm16a-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx); [AliExpress](https://www.aliexpress.com/store/product/bm16a-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom/3034003_32970629907.html) | 9 | * Hardware Availability: [KPrepublic](https://kprepublic.com/products/bm16a-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx); [AliExpress](https://www.aliexpress.com/store/product/bm16a-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom/3034003_32970629907.html) |
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make bm16a:default | 13 | make kprepublic/bm16a:default |
| 14 | 14 | ||
| 15 | 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 | 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/kprepublic/bm16s/readme.md b/keyboards/kprepublic/bm16s/readme.md index 097a38008..6a887e553 100644 --- a/keyboards/kprepublic/bm16s/readme.md +++ b/keyboards/kprepublic/bm16s/readme.md | |||
| @@ -2,12 +2,12 @@ | |||
| 2 | 2 | ||
| 3 | A 16-key macropad, with USB C and per-key RGB backlighting. This is a variant of the BM16A, but with low profile Choc switches. | 3 | A 16-key macropad, with USB C and per-key RGB backlighting. This is a variant of the BM16A, but with low profile Choc switches. |
| 4 | 4 | ||
| 5 | Keyboard Maintainer: QMK Community | 5 | * Keyboard Maintainer: QMK Community |
| 6 | Hardware Supported: The PCBs, controllers supported | 6 | * Hardware Supported: The PCBs, controllers supported |
| 7 | Hardware Availability: [KPrepublic](https://kprepublic.com/collections/pcb/products/bm16s-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch-leds-choc-switch); [AliExpress](https://www.aliexpress.com/item/bm16s-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch/32999247908.html); [Massdrop](https://www.massdrop.com/buy/78169) | 7 | * Hardware Availability: [KPrepublic](https://kprepublic.com/collections/pcb/products/bm16s-16-keys-custom-mechanical-keyboard-pcb-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch-leds-choc-switch); [AliExpress](https://www.aliexpress.com/item/bm16s-16-keys-Custom-Mechanical-Keyboard-PCB-plate-programmed-numpad-layouts-qmk-firmware-with-rgb-switch/32999247908.html); [Massdrop](https://www.massdrop.com/buy/78169) |
| 8 | 8 | ||
| 9 | Make example for this keyboard (after setting up your build environment): | 9 | Make example for this keyboard (after setting up your build environment): |
| 10 | 10 | ||
| 11 | make bm16s:default | 11 | make kprepublic/bm16s:default |
| 12 | 12 | ||
| 13 | 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 | 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/kprepublic/bm40hsrgb/readme.md b/keyboards/kprepublic/bm40hsrgb/readme.md index a2448f957..609b3c418 100644 --- a/keyboards/kprepublic/bm40hsrgb/readme.md +++ b/keyboards/kprepublic/bm40hsrgb/readme.md | |||
| @@ -12,10 +12,10 @@ This firmware was originally taken from a kbfirmware.json and manually converted | |||
| 12 | 12 | ||
| 13 | Make example for this keyboard (after setting up your build environment): | 13 | Make example for this keyboard (after setting up your build environment): |
| 14 | 14 | ||
| 15 | make bm40hsrgb:default | 15 | make kprepublic/bm40hsrgb:default |
| 16 | 16 | ||
| 17 | Flashing example for this keyboard: | 17 | Flashing example for this keyboard: |
| 18 | 18 | ||
| 19 | make bm40hsrgb:default:flash | 19 | make kprepublic/bm40hsrgb:default:flash |
| 20 | 20 | ||
| 21 | 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). | 21 | 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/kprepublic/bm43a/readme.md b/keyboards/kprepublic/bm43a/readme.md index ee5c17333..6be28a7ef 100644 --- a/keyboards/kprepublic/bm43a/readme.md +++ b/keyboards/kprepublic/bm43a/readme.md | |||
| @@ -4,13 +4,12 @@ A 40% mechanical keyboard. | |||
| 4 | 4 | ||
| 5 | This firmware was originally taken from a kbfirmware.json and converted through [kbf_qmk_converter](https://noroadsleft.github.io/kbf_qmk_converter/). You may find the original `.json` files [here](https://drive.google.com/drive/folders/11DowBYrFN_uCNa9Q9bXwuMn91vmZYBcG). | 5 | This firmware was originally taken from a kbfirmware.json and converted through [kbf_qmk_converter](https://noroadsleft.github.io/kbf_qmk_converter/). You may find the original `.json` files [here](https://drive.google.com/drive/folders/11DowBYrFN_uCNa9Q9bXwuMn91vmZYBcG). |
| 6 | 6 | ||
| 7 | 7 | * Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) | |
| 8 | Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) | 8 | * Hardware Supported: bm43a PCB |
| 9 | Hardware Supported: bm43a PCB | 9 | * Hardware Availability: [KPRepublic](https://kprepublic.com/products/bm43a-bm43-43-keys-40-custom-mechanical-keyboard-pcb-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx) |
| 10 | Hardware Availability: [KPRepublic](https://kprepublic.com/products/bm43a-bm43-43-keys-40-custom-mechanical-keyboard-pcb-programmed-numpad-layouts-qmk-firmware-with-rgb-bottom-underglow-alps-mx) | ||
| 11 | 10 | ||
| 12 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 13 | 12 | ||
| 14 | make bm43a:default | 13 | make kprepublic/bm43a:default |
| 15 | 14 | ||
| 16 | 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 | 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/kprepublic/bm60poker/readme.md b/keyboards/kprepublic/bm60poker/readme.md index 62dde405c..b276a1555 100644 --- a/keyboards/kprepublic/bm60poker/readme.md +++ b/keyboards/kprepublic/bm60poker/readme.md | |||
| @@ -8,8 +8,6 @@ A 60% hotswap inswitch RGB (north facing) keyboard from KP Republic. | |||
| 8 | 8 | ||
| 9 | Make example for this keyboard (after setting up your build environment): | 9 | Make example for this keyboard (after setting up your build environment): |
| 10 | 10 | ||
| 11 | make bm60poker:default | 11 | make kprepublic/bm60poker:default |
| 12 | 12 | ||
| 13 | 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 | 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). |
| 14 | |||
| 15 | Video tutorials for customizing the layout: [QMK Tutorials](https://www.youtube.com/playlist?list=PLZlceRZZjRugJFL-vnenYnDrbMc6wu_e_) - By MechMerlin | ||
diff --git a/keyboards/kprepublic/bm60rgb/readme.md b/keyboards/kprepublic/bm60rgb/readme.md index dc093c7b4..d0d5ff1a4 100644 --- a/keyboards/kprepublic/bm60rgb/readme.md +++ b/keyboards/kprepublic/bm60rgb/readme.md | |||
| @@ -8,6 +8,6 @@ A 60% hotswap inswitch RGB keyboard from KP Republic. | |||
| 8 | 8 | ||
| 9 | Make example for this keyboard (after setting up your build environment): | 9 | Make example for this keyboard (after setting up your build environment): |
| 10 | 10 | ||
| 11 | make bm60rgb:default | 11 | make kprepublic/bm60rgb:default |
| 12 | 12 | ||
| 13 | 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 | 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/kprepublic/bm60rgb_iso/readme.md b/keyboards/kprepublic/bm60rgb_iso/readme.md index 8ae86e4a6..fec112650 100644 --- a/keyboards/kprepublic/bm60rgb_iso/readme.md +++ b/keyboards/kprepublic/bm60rgb_iso/readme.md | |||
| @@ -10,10 +10,10 @@ A 60% ISO hotswap inswitch RGB keyboard. | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make bm60rgb_iso:default | 13 | make kprepublic/bm60rgb_iso:default |
| 14 | 14 | ||
| 15 | Flashing example for this keyboard: | 15 | Flashing example for this keyboard: |
| 16 | 16 | ||
| 17 | make bm60rgb_iso:default:flash | 17 | make kprepublic/bm60rgb_iso:default:flash |
| 18 | 18 | ||
| 19 | 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). | 19 | 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/kprepublic/bm65iso/readme.md b/keyboards/kprepublic/bm65iso/readme.md index 5b6083ba4..466a0341a 100644 --- a/keyboards/kprepublic/bm65iso/readme.md +++ b/keyboards/kprepublic/bm65iso/readme.md | |||
| @@ -10,11 +10,11 @@ A 65% hotswap in switch RGB keyboard from KPRepublic. | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make bm65iso:default | 13 | make kprepublic/bm65iso:default |
| 14 | 14 | ||
| 15 | Flashing example for this keyboard: | 15 | Flashing example for this keyboard: |
| 16 | 16 | ||
| 17 | make bm65iso:default:flash | 17 | make kprepublic/bm65iso:default:flash |
| 18 | 18 | ||
| 19 | To reset the board into bootloader mode, do one of the following: | 19 | To reset the board into bootloader mode, do one of the following: |
| 20 | 20 | ||
diff --git a/keyboards/kprepublic/bm68rgb/readme.md b/keyboards/kprepublic/bm68rgb/readme.md index 4087fd866..f09efb1ab 100644 --- a/keyboards/kprepublic/bm68rgb/readme.md +++ b/keyboards/kprepublic/bm68rgb/readme.md | |||
| @@ -10,11 +10,11 @@ A 65% hotswap in switch RGB keyboard from KPRepublic. | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make bm68rgb:default | 13 | make kprepublic/bm68rgb:default |
| 14 | 14 | ||
| 15 | Flashing example for this keyboard: | 15 | Flashing example for this keyboard: |
| 16 | 16 | ||
| 17 | make bm68rgb:default:flash | 17 | make kprepublic/bm68rgb:default:flash |
| 18 | 18 | ||
| 19 | To reset the board into bootloader mode, do one of the following: | 19 | To reset the board into bootloader mode, do one of the following: |
| 20 | 20 | ||
diff --git a/keyboards/kprepublic/cospad/readme.md b/keyboards/kprepublic/cospad/readme.md index 9bb3dfdc0..70f9658cf 100644 --- a/keyboards/kprepublic/cospad/readme.md +++ b/keyboards/kprepublic/cospad/readme.md | |||
| @@ -13,6 +13,6 @@ Supported Layouts: | |||
| 13 | 13 | ||
| 14 | Make example for this keyboard (after setting up your build environment): | 14 | Make example for this keyboard (after setting up your build environment): |
| 15 | 15 | ||
| 16 | make cospad:default | 16 | make kprepublic/cospad:default |
| 17 | 17 | ||
| 18 | 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). | 18 | 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/kprepublic/jj40/readme.md b/keyboards/kprepublic/jj40/readme.md index 5f4d2c8a9..06ca2e657 100644 --- a/keyboards/kprepublic/jj40/readme.md +++ b/keyboards/kprepublic/jj40/readme.md | |||
| @@ -10,11 +10,11 @@ A compact 40% (12x4) ortholinear keyboard kit made and KPRepublic on AliExpress. | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make jj40:default | 13 | make kprepublic/jj40:default |
| 14 | 14 | ||
| 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) | 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
| 16 | 16 | ||
| 17 | make jj40:default:flash | 17 | make kprepublic/jj40:default:flash |
| 18 | 18 | ||
| 19 | **Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard. | 19 | **Reset Key**: Hold down the *Top Right Key* key, commonly programmed as *Backspace* while plugging in the keyboard. |
| 20 | 20 | ||
diff --git a/keyboards/kprepublic/jj4x4/readme.md b/keyboards/kprepublic/jj4x4/readme.md index 714e8e88f..b6e586616 100644 --- a/keyboards/kprepublic/jj4x4/readme.md +++ b/keyboards/kprepublic/jj4x4/readme.md | |||
| @@ -10,11 +10,11 @@ A 4x4 keypad kit made and KPRepublic on AliExpress. This is a chopped off versio | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make jj4x4:default | 13 | make kprepublic/jj4x4:default |
| 14 | 14 | ||
| 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) | 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
| 16 | 16 | ||
| 17 | make jj4x4:default:flash | 17 | make kprepublic/jj4x4:default:flash |
| 18 | 18 | ||
| 19 | **Reset Key**: | 19 | **Reset Key**: |
| 20 | 20 | ||
diff --git a/keyboards/kprepublic/jj50/readme.md b/keyboards/kprepublic/jj50/readme.md index 9719f01ec..c34b5d8ee 100644 --- a/keyboards/kprepublic/jj50/readme.md +++ b/keyboards/kprepublic/jj50/readme.md | |||
| @@ -10,11 +10,11 @@ A compact 50% (5x12) ortholinear keyboard made and sold by KPrepublic. | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make jj50:default | 13 | make kprepublic/jj50:default |
| 14 | 14 | ||
| 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) | 15 | Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid)) |
| 16 | 16 | ||
| 17 | make jj50:default:flash | 17 | make kprepublic/jj50:default:flash |
| 18 | 18 | ||
| 19 | **Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard. | 19 | **Reset Key**: Hold down the key `Backspace` (`Key below the top right key`) while plugging in the keyboard. |
| 20 | 20 | ||
diff --git a/keyboards/ktec/daisy/readme.md b/keyboards/ktec/daisy/readme.md index a8a93bf79..b6a8e6012 100644 --- a/keyboards/ktec/daisy/readme.md +++ b/keyboards/ktec/daisy/readme.md | |||
| @@ -10,6 +10,6 @@ A 40% keyboard kit sold by KPrepublic. | |||
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make daisy:default | 13 | make ktec/daisy:default |
| 14 | 14 | ||
| 15 | 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 | 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/ktec/ergodone/readme.md b/keyboards/ktec/ergodone/readme.md index 82c1043da..7998a274f 100644 --- a/keyboards/ktec/ergodone/readme.md +++ b/keyboards/ktec/ergodone/readme.md | |||
| @@ -1,5 +1,4 @@ | |||
| 1 | ErgoDone | 1 | # ErgoDone |
| 2 | ======== | ||
| 3 | 2 | ||
| 4 |  | 3 |  |
| 5 | 4 | ||
| @@ -12,17 +11,13 @@ The ErgoDone is a modified version of the ErgoDox, made by K.T.E.C., with pre-so | |||
| 12 | - [AliExpress](https://www.aliexpress.com/store/product/ergodone-Custom-Mechanical-Keyboard-TKG-TOOLS-PCB-programmed-Ergonomic-Keyboard-Kit-similar-with-infinity-ergodox/3034003_32830050940.html) | 11 | - [AliExpress](https://www.aliexpress.com/store/product/ergodone-Custom-Mechanical-Keyboard-TKG-TOOLS-PCB-programmed-Ergonomic-Keyboard-Kit-similar-with-infinity-ergodox/3034003_32830050940.html) |
| 13 | - [KBDfans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping) | 12 | - [KBDfans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping) |
| 14 | 13 | ||
| 15 | # Building the firmware | 14 | Make example for this keyboard (after setting up your build environment): |
| 16 | 15 | ||
| 17 | [Install the build tools.](https://docs.qmk.fm/#/getting_started_build_tools) | 16 | make ktec/ergodone:default |
| 18 | 17 | ||
| 19 | In the root directory of the repository, build the firmware with a command like: | 18 | 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). |
| 20 | 19 | ||
| 21 | make ergodone:default | 20 | ## Flashing the firmware onto the keyboard |
| 22 | |||
| 23 | For more information on the layout option and other ones, see the [`make` guide](https://docs.qmk.fm/#/getting_started_make_guide). | ||
| 24 | |||
| 25 | # Flashing the firmware onto the keyboard | ||
| 26 | 21 | ||
| 27 | The ErgoDone uses a customized HID bootloader rather than the Teensy one. It doesn't need an OS driver, and the required actions before flashing are a little different than with an ErgoDox. | 22 | The ErgoDone uses a customized HID bootloader rather than the Teensy one. It doesn't need an OS driver, and the required actions before flashing are a little different than with an ErgoDox. |
| 28 | 23 | ||
diff --git a/keyboards/ktec/staryu/readme.md b/keyboards/ktec/staryu/readme.md index 1b2f9e8f5..f0d019de2 100644 --- a/keyboards/ktec/staryu/readme.md +++ b/keyboards/ktec/staryu/readme.md | |||
| @@ -4,12 +4,12 @@ | |||
| 4 | 4 | ||
| 5 | A 5 key macropad, designed by Kai and sold by KPRepublic. | 5 | A 5 key macropad, designed by Kai and sold by KPRepublic. |
| 6 | 6 | ||
| 7 | Keyboard Maintainer: QMK Community | 7 | * Keyboard Maintainer: QMK Community |
| 8 | Hardware Supported: Staryu (only the non-lite version has been tested) | 8 | * Hardware Supported: Staryu (only the non-lite version has been tested) |
| 9 | Hardware Availability: [AliExpress](https://www.aliexpress.com/item/Staryu-Mini-Macro-Pad-custom-keyboard-by-tkg-kai-Mini-macro-pad-mechanical-keyboard-5-keys/32817560746.html) | 9 | * Hardware Availability: [AliExpress](https://www.aliexpress.com/item/Staryu-Mini-Macro-Pad-custom-keyboard-by-tkg-kai-Mini-macro-pad-mechanical-keyboard-5-keys/32817560746.html) |
| 10 | 10 | ||
| 11 | Make example for this keyboard (after setting up your build environment): | 11 | Make example for this keyboard (after setting up your build environment): |
| 12 | 12 | ||
| 13 | make staryu:default | 13 | make ktec/staryu:default |
| 14 | 14 | ||
| 15 | 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. | 15 | 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. |
diff --git a/keyboards/xiudi/xd002/readme.md b/keyboards/xiudi/xd002/readme.md index 6358bc754..65522fda2 100644 --- a/keyboards/xiudi/xd002/readme.md +++ b/keyboards/xiudi/xd002/readme.md | |||
| @@ -12,7 +12,7 @@ | |||
| 12 | 12 | ||
| 13 | Make example for this keyboard (after setting up your build environment): | 13 | Make example for this keyboard (after setting up your build environment): |
| 14 | 14 | ||
| 15 | make xd002:default | 15 | make xiudi/xd002:default |
| 16 | 16 | ||
| 17 | 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). | 17 | 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). |
| 18 | 18 | ||
diff --git a/keyboards/xiudi/xd004/readme.md b/keyboards/xiudi/xd004/readme.md index 8f858a841..6ee2fa2cd 100644 --- a/keyboards/xiudi/xd004/readme.md +++ b/keyboards/xiudi/xd004/readme.md | |||
| @@ -1,13 +1,12 @@ | |||
| 1 | XD004 | 1 | # XD004 |
| 2 | == | ||
| 3 | 2 | ||
| 4 | 4-keys board | 3 | 4-keys board |
| 5 | 4 | ||
| 6 |  | 5 |  |
| 7 | 6 | ||
| 8 | Keyboard Maintainer: QMK Community | 7 | * Keyboard Maintainer: QMK Community |
| 9 | Hardware Supported: XD004 PCB v1.0 | 8 | * Hardware Supported: XD004 PCB v1.0 |
| 10 | Hardware Availability: [KPRepublic](https://kprepublic.com/products/xd004-xiudi-4-custom-mechanical-keyboard-4-keys-switch-leds-pcb-programmed-hot-swappable-macro-key-silver-case-micro-port) | 9 | * Hardware Availability: [KPRepublic](https://kprepublic.com/products/xd004-xiudi-4-custom-mechanical-keyboard-4-keys-switch-leds-pcb-programmed-hot-swappable-macro-key-silver-case-micro-port) |
| 11 | 10 | ||
| 12 | To put this board in DFU (firmware update) mode, bridge the last two pins (#5 & 6) of the 6-pin "J2" header on the opposite edge of the board to the USB port" | 11 | To put this board in DFU (firmware update) mode, bridge the last two pins (#5 & 6) of the 6-pin "J2" header on the opposite edge of the board to the USB port" |
| 13 | ``` | 12 | ``` |
| @@ -23,8 +22,12 @@ To put this board in DFU (firmware update) mode, bridge the last two pins (#5 & | |||
| 23 | ----+ | 22 | ----+ |
| 24 | ``` | 23 | ``` |
| 25 | 24 | ||
| 26 | To build with a default keymap (not useful at all, have a look at other keymaps): | 25 | Make example for this keyboard (after setting up your build environment): |
| 27 | 26 | ||
| 28 | ```make xd004/v1:default``` | 27 | make xiudi/xd004/v1:default |
| 28 | |||
| 29 | Flashing example for this keyboard: | ||
| 30 | |||
| 31 | make xiudi/xd004/v1:default:flash | ||
| 29 | 32 | ||
| 30 | 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). | 33 | 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/xiudi/xd60/readme.md b/keyboards/xiudi/xd60/readme.md index f4926d01a..db03613b8 100644 --- a/keyboards/xiudi/xd60/readme.md +++ b/keyboards/xiudi/xd60/readme.md | |||
| @@ -11,7 +11,7 @@ Compact 60% with arrows. | |||
| 11 | 11 | ||
| 12 | Make example for this keyboard (after setting up your build environment): | 12 | Make example for this keyboard (after setting up your build environment): |
| 13 | 13 | ||
| 14 | make xd60/rev2:default # rev2 | 14 | make xiudi/xd60/rev2:default # rev2 |
| 15 | make xd60/rev3:default # rev3 | 15 | make xiudi/xd60/rev3:default # rev3 |
| 16 | 16 | ||
| 17 | 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). | 17 | 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/xiudi/xd68/readme.md b/keyboards/xiudi/xd68/readme.md index a62d9c7c5..dd12ad632 100644 --- a/keyboards/xiudi/xd68/readme.md +++ b/keyboards/xiudi/xd68/readme.md | |||
| @@ -12,8 +12,8 @@ | |||
| 12 | 12 | ||
| 13 | Make example for this keyboard (after setting up your build environment): | 13 | Make example for this keyboard (after setting up your build environment): |
| 14 | 14 | ||
| 15 | make xd68:default | 15 | make xiudi/xd68:default |
| 16 | make xd68:default_iso # default ISO UK layout | 16 | make xiudi/xd68:default_iso # default ISO UK layout |
| 17 | 17 | ||
| 18 | ## Layouts | 18 | ## Layouts |
| 19 | 19 | ||
diff --git a/keyboards/xiudi/xd75/readme.md b/keyboards/xiudi/xd75/readme.md index 65da5cc02..4b0bf1c3b 100644 --- a/keyboards/xiudi/xd75/readme.md +++ b/keyboards/xiudi/xd75/readme.md | |||
| @@ -12,11 +12,11 @@ This port of the QMK firmware is my first shot at using QMK, so if you see any f | |||
| 12 | 12 | ||
| 13 | Make example for this keyboard (after setting up your build environment): | 13 | Make example for this keyboard (after setting up your build environment): |
| 14 | 14 | ||
| 15 | make xd75:default | 15 | make xiudi/xd75:default |
| 16 | 16 | ||
| 17 | Flashing example for this keyboard: | 17 | Flashing example for this keyboard: |
| 18 | 18 | ||
| 19 | make xd75:default:flash | 19 | make xiudi/xd75:default:flash |
| 20 | 20 | ||
| 21 | 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). | 21 | 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). |
| 22 | 22 | ||
diff --git a/keyboards/xiudi/xd84/readme.md b/keyboards/xiudi/xd84/readme.md index b8d9c5dbb..4efedca36 100644 --- a/keyboards/xiudi/xd84/readme.md +++ b/keyboards/xiudi/xd84/readme.md | |||
| @@ -8,16 +8,16 @@ Keyboard with 84 Keys & RGB LED Underglow | |||
| 8 | - iso and ansi support | 8 | - iso and ansi support |
| 9 | - Uses Kimera core | 9 | - Uses Kimera core |
| 10 | 10 | ||
| 11 | Keyboard Maintainer: QMK Community | 11 | * Keyboard Maintainer: QMK Community |
| 12 | Hardware Supported: XD84 | 12 | * Hardware Supported: XD84 |
| 13 | Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-70-custom-keyboard-pcb) | 13 | * Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-70-custom-keyboard-pcb) |
| 14 | 14 | ||
| 15 | Make example for this keyboard (after setting up your build environment): | 15 | Make example for this keyboard (after setting up your build environment): |
| 16 | 16 | ||
| 17 | make xd84:default | 17 | make xiudi/xd84:default |
| 18 | 18 | ||
| 19 | Install examples: | 19 | Flashing example for this keyboard: |
| 20 | 20 | ||
| 21 | make xd84:default:dfu | 21 | make xiudi/xd84:default:flash |
| 22 | 22 | ||
| 23 | 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). | 23 | 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/xiudi/xd84pro/readme.md b/keyboards/xiudi/xd84pro/readme.md index 76e83c6c5..7641a26b7 100644 --- a/keyboards/xiudi/xd84pro/readme.md +++ b/keyboards/xiudi/xd84pro/readme.md | |||
| @@ -15,10 +15,10 @@ The silkscreen printing on the PCB refers to this as the "XD84 v2.0". | |||
| 15 | 15 | ||
| 16 | Make example for this keyboard (after setting up your build environment): | 16 | Make example for this keyboard (after setting up your build environment): |
| 17 | 17 | ||
| 18 | make xd84pro:default | 18 | make xiudi/xd84pro:default |
| 19 | 19 | ||
| 20 | Flashing example for this keyboard: | 20 | Flashing example for this keyboard: |
| 21 | 21 | ||
| 22 | make xd84pro:default:flash | 22 | make xiudi/xd84pro:default:flash |
| 23 | 23 | ||
| 24 | 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). | 24 | 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/xiudi/xd87/readme.md b/keyboards/xiudi/xd87/readme.md index 0b9389740..7beae2c6c 100644 --- a/keyboards/xiudi/xd87/readme.md +++ b/keyboards/xiudi/xd87/readme.md | |||
| @@ -11,16 +11,16 @@ | |||
| 11 | 11 | ||
| 12 | Make example for this keyboard (after setting up your build environment): | 12 | Make example for this keyboard (after setting up your build environment): |
| 13 | 13 | ||
| 14 | make xd87:default | 14 | make xiudi/xd87:default |
| 15 | 15 | ||
| 16 | It also supports the tkl_ansi and tkl_iso community layouts: | 16 | It also supports the tkl_ansi and tkl_iso community layouts: |
| 17 | 17 | ||
| 18 | # Build firmware with ANSI layout | 18 | # Build firmware with ANSI layout |
| 19 | make xd87:default_tkl_ansi | 19 | make xiudi/xd87:default_tkl_ansi |
| 20 | # Build firmware with ISO layout | 20 | # Build firmware with ISO layout |
| 21 | make xd87:default_tkl_iso | 21 | make xiudi/xd87:default_tkl_iso |
| 22 | 22 | ||
| 23 | 23 | ||
| 24 | The keyboard can be reset to bootloader by using bootmagic (space+b by default) or short out the small connector between the Delete and End keys. | 24 | The keyboard can be reset to bootloader by using bootmagic (top left key by default) or short out the small connector between the Delete and End keys. |
| 25 | 25 | ||
| 26 | 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). \ No newline at end of file | 26 | 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). \ No newline at end of file |
diff --git a/keyboards/xiudi/xd96/readme.md b/keyboards/xiudi/xd96/readme.md index bf01db8bb..5f4038ef3 100644 --- a/keyboards/xiudi/xd96/readme.md +++ b/keyboards/xiudi/xd96/readme.md | |||
| @@ -7,16 +7,16 @@ Keyboard with 96 Keys & RGB LED Underglow | |||
| 7 | - ISO and ANSI support | 7 | - ISO and ANSI support |
| 8 | - Uses Kimera core | 8 | - Uses Kimera core |
| 9 | 9 | ||
| 10 | Keyboard Maintainer: QMK Community | 10 | * Keyboard Maintainer: QMK Community |
| 11 | Hardware Supported: XD96 | 11 | * Hardware Supported: XD96 |
| 12 | Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd96-pcb-90-custom-mechanical-keyboard-supports-tkg-tools-underglow-rgb-programmed); [AliExpress](https://aliexpress.com/item/cospad-Custom-Mechanical-Keyboard-Kit-up-tp-24-keys-Supports-TKG-TOOLS-Underglow-RGB-PCB-20/32818383873.html) | 12 | * Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd96-pcb-90-custom-mechanical-keyboard-supports-tkg-tools-underglow-rgb-programmed); [AliExpress](https://aliexpress.com/item/cospad-Custom-Mechanical-Keyboard-Kit-up-tp-24-keys-Supports-TKG-TOOLS-Underglow-RGB-PCB-20/32818383873.html) |
| 13 | 13 | ||
| 14 | Make example for this keyboard (after setting up your build environment): | 14 | Make example for this keyboard (after setting up your build environment): |
| 15 | 15 | ||
| 16 | make xd96:default | 16 | make xiudi/xd96:default |
| 17 | 17 | ||
| 18 | Install examples: | 18 | Flashing example for this keyboard: |
| 19 | 19 | ||
| 20 | make xd96:default:dfu | 20 | make xiudi/xd96:default:flash |
| 21 | 21 | ||
| 22 | 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). | 22 | 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). |
