diff options
Diffstat (limited to 'keyboards/kprepublic/bm80/readme.md')
| -rw-r--r-- | keyboards/kprepublic/bm80/readme.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/kprepublic/bm80/readme.md b/keyboards/kprepublic/bm80/readme.md new file mode 100644 index 000000000..a0d8e8cf9 --- /dev/null +++ b/keyboards/kprepublic/bm80/readme.md | |||
| @@ -0,0 +1,30 @@ | |||
| 1 | # bm80 | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | A tkl, hotswap, in switch RGB keyboard from KPRepublic. | ||
| 6 | |||
| 7 | * Keyboard Maintainer: [peepeetee](https://github.com/peepeetee) | ||
| 8 | * Hardware Supported: BM80 | ||
| 9 | * 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) | ||
| 10 | |||
| 11 | Make example for this keyboard (after setting up your build environment): | ||
| 12 | |||
| 13 | make kprepublic/bm80:default | ||
| 14 | |||
| 15 | Flashing example for this keyboard: | ||
| 16 | |||
| 17 | make kprepublic/bm80:default:flash | ||
| 18 | |||
| 19 | To reset the board into bootloader mode, do one of the following: | ||
| 20 | |||
| 21 | * Short the two-pad footprint between the "delete" key and the "end" key while the board is plugged in | ||
| 22 | * Press the switch labled RST on the back of the PCB, near the MCU, while the board is plugged in | ||
| 23 | * Hold the Esc key while connecting the USB cable (also erases persistent settings) | ||
| 24 | |||
| 25 | All of the RGB matrix effects are enabled by default. To disable specific ones, see [this section](https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects) for more information. | ||
| 26 | |||
| 27 | |||
| 28 | 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). | ||
| 29 | |||
| 30 | |||
