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 /keyboards/kprepublic | |
| parent | 48d0ad28e789abae0413002f9dbda38f1a82924a (diff) | |
| download | qmk_firmware-87cdb1cf9a89a702f0c4286d4260fc84b18ae042.tar.gz qmk_firmware-87cdb1cf9a89a702f0c4286d4260fc84b18ae042.zip | |
Update readme files (#14172)
Diffstat (limited to 'keyboards/kprepublic')
| -rw-r--r-- | keyboards/kprepublic/bm16a/readme.md | 8 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm16s/readme.md | 8 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm40hsrgb/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm43a/readme.md | 9 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm60poker/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm60rgb/readme.md | 2 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm60rgb_iso/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm65iso/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/bm68rgb/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/cospad/readme.md | 2 | ||||
| -rw-r--r-- | keyboards/kprepublic/jj40/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/jj4x4/readme.md | 4 | ||||
| -rw-r--r-- | keyboards/kprepublic/jj50/readme.md | 4 |
13 files changed, 29 insertions, 32 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 | ||
