rename kprepublic bm keyboards to have a standardized naming format (#15047)

* change missed kprepublic readmes

* fix xiudi readmes

* initial change, see pr description

* change readmes

* changes names in readmes and device descriptors
This commit is contained in:
peepeetee 2021-11-18 05:37:23 +08:00 committed by GitHub
parent cc7600cf0e
commit c5f1e9797a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
124 changed files with 107 additions and 107 deletions

View file

@ -4,13 +4,13 @@
- Compile:
`qmk compile -kb bm40hsrgb -km gabustoledo`
`qmk compile -kb kprepublic/bm40hsrgb -km gabustoledo`
### Flash
- Flash:
`qmk flash -kb bm40hsrgb -km gabustoledo`
`qmk flash -kb kprepublic/bm40hsrgb -km gabustoledo`
# Layout

View file

@ -30,11 +30,11 @@ Sigma Squared modifies on **Miryoku** in the following ways:
- to directly flash to board:
`qmk flash -kb bm40hsrgb -km signynt`
`qmk flash -kb kprepublic/bm40hsrgb -km signynt`
- to only compile:
`qmk compile -kb bm40hsrgb -km signynt`
`qmk compile -kb kprepublic/bm40hsrgb -km signynt`

View file

@ -30,11 +30,11 @@ Sigma Squared modifies on **Miryoku** in the following ways:
- to directly flash to board:
`qmk flash -kb bm40hsrgb -km signynt`
`qmk flash -kb kprepublic/bm40hsrgb -km signynt`
- to only compile:
`qmk compile -kb bm40hsrgb -km signynt`
`qmk compile -kb kprepublic/bm40hsrgb -km signynt`

View file

@ -30,11 +30,11 @@ Sigma Squared modifies on **Miryoku** in the following ways:
- to directly flash to board:
`qmk flash -kb bm40hsrgb -km signynt`
`qmk flash -kb kprepublic/bm40hsrgb -km signynt`
- to only compile:
`qmk compile -kb bm40hsrgb -km signynt`
`qmk compile -kb kprepublic/bm40hsrgb -km signynt`

View file

@ -19,7 +19,7 @@ And a view on the actual build:
![layout](https://raw.githubusercontent.com/stevexyz/qmk_firmware/master/keyboards/bm43a/keymaps/stevexyz/actualbuild.jpeg)
In order to compile the module from qmk root directory use the command 'make bm43a:stevexyz'
In order to compile the module from qmk root directory use the command 'make kprepublic/bm43a:stevexyz'
And in order to upload the new firmware use the command: 'qmk flash -kb bm43a -km stevexyz' (you can initiate programming with keyboard RESET key, that in this keymap has been moved on the backspace button in the "lights" layer)
And in order to upload the new firmware use the command: 'qmk flash -kb kprepublic/bm43a -km stevexyz' (you can initiate programming with keyboard RESET key, that in this keymap has been moved on the backspace button in the "lights" layer)

View file

@ -1,13 +1,13 @@
# BM60 RGB
# BM60HSRGB
A 60% hotswap inswitch RGB keyboard from KP Republic.
* Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin)
* Hardware Supported: BM60 RGB
* Hardware Supported: BM60HSRGB
* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm60-rgb-60-gh60-hot-swappable-pcb-programmed-qmk-firmware-type-c)
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm60rgb/rev1:default
make kprepublic/bm60hsrgb/rev1: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).

View file

@ -24,7 +24,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define PRODUCT_ID 0xEF8C
#define DEVICE_VER 0x0001
#define MANUFACTURER KP Republic
#define PRODUCT BM60 RGB
#define PRODUCT BM60HSRGB
/* key matrix size */
#define MATRIX_ROWS 5

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "BM60 RGB",
"keyboard_name": "BM60HSRGB",
"url": "",
"maintainer": "qmk",
"layout_aliases": {

View file

@ -1,6 +1,6 @@
# BM60 RGB ISO
# BM60HSRGB_ISO
![BM60 RGB ISO](https://i.imgur.com/i3gk2vql.jpg)
![BM60HSRGB_ISO](https://i.imgur.com/i3gk2vql.jpg)
A 60% ISO hotswap inswitch RGB keyboard.
@ -10,10 +10,10 @@ A 60% ISO hotswap inswitch RGB keyboard.
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm60rgb_iso/rev1:default
make kprepublic/bm60hsrgb_iso/rev1:default
Flashing example for this keyboard:
make kprepublic/bm60rgb_iso:default:flash
make kprepublic/bm60hsrgb_iso:default:flash
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

@ -24,7 +24,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define PRODUCT_ID 0xEF8C
#define DEVICE_VER 0x0001
#define MANUFACTURER KPRepublic
#define PRODUCT bm60hsrgb-iso
#define PRODUCT BM60HSRGB_ISO
/* key matrix size */
#define MATRIX_ROWS 5

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "BM60 RGB ISO",
"keyboard_name": "BM60HSRGB_ISO",
"url": "",
"maintainer": "qmk",
"layouts": {

View file

@ -1,13 +1,13 @@
# BM60 Poker 60% Mechanical Keyboard RGB PCB
# BM60HSRGB_Poker 60% Mechanical Keyboard RGB PCB
A 60% hotswap inswitch RGB (north facing) keyboard from KP Republic.
* Keyboard Maintainer: [ipetepete](https://github.com/ipetepete)
* Hardware Supported: BM60 POKER RGB
* Hardware Supported: BM60HSRGB_Poker
* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm60-rgb-poker-60-gh60-hot-swap-custom-mechanical-keyboard-pcb-program-qmk-underglow-type-c)
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm60poker/rev1:default
make kprepublic/bm60hsrgb_poker/rev1: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).

View file

@ -24,7 +24,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define PRODUCT_ID 0xEF8D
#define DEVICE_VER 0x0001
#define MANUFACTURER KP Republic
#define PRODUCT BM60 RGB POKER
#define PRODUCT BM60HSRGB_POKER
/* key matrix size */
#define MATRIX_ROWS 5

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "BM60 POKER RGB",
"keyboard_name": "BM60HSRGB_POKER",
"url": "",
"maintainer": "qmk",
"layouts": {

View file

@ -1,20 +1,20 @@
# bm65rgb
# BM65HSRGB
![bm65rgb](https://i.imgur.com/DskSCve.jpeg)
![BM65HSRGB](https://i.imgur.com/DskSCve.jpeg)
A 65% hotswap in switch RGB keyboard from KPRepublic.
* Keyboard Maintainer: [bytesapart](https://github.com/bytesapart)
* Hardware Supported: BM65 RGB
* Hardware Supported: BM65HSRGB
* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm65rgb-bm65-rgb-65-hot-swappable-custom-mechanical-keyboard-pcb-programmed-qmk-via-firmware-full-rgb-switch-underglow-type-c?_pos=1&_sid=5b9a6a5d0&_ss=r)
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm65rgb/rev1:default
make kprepublic/bm65hsrgb/rev1:default
Flashing example for this keyboard:
make kprepublic/bm65rgb/rev1:default:flash
make kprepublic/bm65hsrgb/rev1:default:flash
To reset the board into bootloader mode, do one of the following:

View file

@ -24,7 +24,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define PRODUCT_ID 0xEF6E
#define DEVICE_VER 0x0001
#define MANUFACTURER KPRepublic
#define PRODUCT BM65 RGB
#define PRODUCT BM65HSRGB
/* key matrix size */
#define MATRIX_ROWS 5

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "bm65rgb",
"keyboard_name": "BM65HSRGB",
"url": "",
"maintainer": "bytesapart",
"layouts": {

View file

@ -13,7 +13,7 @@
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "bm65iso.h"
#include "bm65hsrgb_iso.h"
#ifdef RGB_MATRIX_ENABLE
led_config_t g_led_config = { {

View file

@ -24,7 +24,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define PRODUCT_ID 0x0653
#define DEVICE_VER 0x0001
#define MANUFACTURER KP Republic
#define PRODUCT BM65ISO
#define PRODUCT BM65HSRGB_ISO
/* key matrix size */
#define MATRIX_ROWS 5

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "bm65iso",
"keyboard_name": "BM65HSRGB_ISO",
"url": "",
"maintainer": "qmk",
"layouts": {

View file

@ -11,10 +11,10 @@
Make example for this keyboard (after setting up your build environment):
make bm65iso:deadolus
make kprepublic/bm65hsrgb_iso:deadolus
Flashing example for this keyboard:
make bm65iso:deadolus:flash
make kprepublic/bm65hsrgb_iso:deadolus:flash
Keyboard Maintainer: **[deadolus](https://github.com/deadolus)**

View file

@ -1,20 +1,20 @@
# bm65iso
# BM65HSRGB_ISO
![bm65iso](https://ae01.alicdn.com/kf/He2fd118856c7490292bc3c299049fdbcp.jpg)
![BM65HSRGB_ISO](https://ae01.alicdn.com/kf/He2fd118856c7490292bc3c299049fdbcp.jpg)
A 65% hotswap in switch RGB keyboard from KPRepublic.
* Keyboard Maintainer: [deadolus](https://github.com/deadolus)
* Hardware Supported: BM65 ISO
* Hardware Supported: BM65HSRGB_ISO
* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm65rgb-bm65-iso-rgb-65-hot-swappable-custom-mechanical-keyboard-pcb-programmed-qmk-via-firmware-rgb-switch-underglow-type-c)
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm65iso:default
make kprepublic/bm65hsrgb_iso:default
Flashing example for this keyboard:
make kprepublic/bm65iso:default:flash
make kprepublic/bm65hsrgb_iso:default:flash
To reset the board into bootloader mode, do one of the following:

View file

@ -14,7 +14,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "bm68rgb.h"
#include "bm68hsrgb.h"
#ifdef RGB_MATRIX_ENABLE
led_config_t g_led_config = { {

View file

@ -24,7 +24,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define PRODUCT_ID 0xEF6F
#define DEVICE_VER 0x0001
#define MANUFACTURER KPRepublic
#define PRODUCT BM68 RGB
#define PRODUCT BM68HSRGB
/* key matrix size */
#define MATRIX_ROWS 5

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "bm68rgb",
"keyboard_name": "BM68HSRGB",
"url": "",
"maintainer": "peepeetee",
"layouts": {

View file

@ -1,20 +1,20 @@
# bm68rgb
# BM68HSRGB
![bm68rgb](https://i.imgur.com/uuYP8OIl.jpeg)
![BM68HSRGB](https://i.imgur.com/uuYP8OIl.jpeg)
A 65% hotswap in switch RGB keyboard from KPRepublic.
* Keyboard Maintainer: [peepeetee](https://github.com/peepeetee)
* Hardware Supported: BM68 RGB
* Hardware Supported: BM68HSRGB
* Hardware Availability: [KP Republic](https://kprepublic.com/products/bm68rgb-bm68-rgb-65-hot-swappable-custom-mechanical-keyboard-pcb-programmed-qmk-via-firmware-full-rgb-switch-underglow-type-c)
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm68rgb:default
make kprepublic/bm68hsrgb:default
Flashing example for this keyboard:
make kprepublic/bm68rgb:default:flash
make kprepublic/bm68hsrgb:default:flash
To reset the board into bootloader mode, do one of the following:

View file

@ -14,7 +14,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "bm80.h"
#include "bm80hsrgb.h"
#ifdef RGB_MATRIX_ENABLE
led_config_t g_led_config = { {

View file

@ -1,5 +1,5 @@
{
"keyboard_name": "bm80",
"keyboard_name": "BM80HSRGB",
"url": "",
"maintainer": "peepeetee",
"layouts": {

View file

@ -1,20 +1,20 @@
# bm80
# BM80HSRGB
![bm80](https://i.imgur.com/AqjEjOi.jpeg)
![BM80HSRGB](https://i.imgur.com/AqjEjOi.jpeg)
A tkl, hotswap, in switch RGB keyboard from KPRepublic.
* Keyboard Maintainer: [peepeetee](https://github.com/peepeetee)
* Hardware Supported: BM80
* Hardware Supported: BM80HSRGB
* Hardware Availability: [KP Republic](https://kprepublic.com/collections/new-arrival/products/bm80rgb-bm80-rgb-80-hot-swappable-custom-mechanical-keyboard-pcb-programmed-qmk-via-firmware-full-rgb-switch-underglow-type-c)
Make example for this keyboard (after setting up your build environment):
make kprepublic/bm80:default
make kprepublic/bm80hsrgb:default
Flashing example for this keyboard:
make kprepublic/bm80:default:flash
make kprepublic/bm80hsrgb:default:flash
To reset the board into bootloader mode, do one of the following:

View file

@ -48,8 +48,8 @@
```bash
cd qmk_firmware
make jj40:cockpit
bootloadHID .build/jj40_cockpit.hex
make kprepublic/jj40:cockpit
bootloadHID .build/kprepublic_jj40_cockpit.hex
```
_if you're getting permission errors use sudo_

View file

@ -11,7 +11,7 @@ I currently have the following layers in my keymap:
* Dual (adjust)
### Note to self:
YOU NEED TO USE [bootloadHID -r jj40_waples.hex](https://github.com/qmk/qmk_firmware/tree/master/keyboards/jj40)
YOU NEED TO USE [bootloadHID -r kprepublic_jj40_waples.hex](https://github.com/qmk/qmk_firmware/tree/master/keyboards/jj40)
## the stuff below is out of date and I think about removing them from this readme

View file

@ -25,4 +25,4 @@ The ErgoDone uses a customized HID bootloader rather than the Teensy one. It doe
![Ergodone Flash Mode](https://i.imgur.com/sNivAnr.jpg)
2. To flash the .hex file, use the `hid_bootloader_cli` utlity from the [TKG Toolkit](https://github.com/kairyu/tkg-toolkit) (as of 2017-10-03, only [this old version](https://github.com/kairyu/tkg-toolkit/blob/b14c67ca8bc84c07e5fc6b2e01ae4002b808243a/windows/bin/hid_bootloader_cli.exe) works under Windows):
hid_bootloader_cli -mmcu=atmega32u4 ergodone_default.hex
hid_bootloader_cli -mmcu=atmega32u4 ktec_ergodone_default.hex

View file

@ -37,7 +37,7 @@ sudo udevadm trigger
**Reset Key**: Hold down key nearest to the USB socket while plugging in the keyboard.
```bash
make xd002:default:flash
make xiudi/xd002:default:flash
# or directly with...
micronucleus --run <firmware.hex>

View file

@ -6,4 +6,4 @@ It also has a 'Super Alt-F4' key for Windows that, when tapped does Alt-F4, unle
## Build
To build the keymap, simply run `make xd004:system_and_media`.
To build the keymap, simply run `make xiudi/xd004:system_and_media`.

View file

@ -19,4 +19,4 @@ There are a few `#define` lines at the beginning of the keymap file that enable
# Build
To build, simply run `make xd60:Jos`
To build, simply run `make xiudi/xd60:Jos`

Some files were not shown because too many files have changed in this diff Show more