summaryrefslogtreecommitdiff
path: root/keyboards/kprepublic/bm80/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-09-28 05:01:22 +0000
committerQMK Bot <hello@qmk.fm>2021-09-28 05:01:22 +0000
commit8b74ba7e755aa73c0b06ca83d6f4c7ee50239842 (patch)
tree6c492c02d9a0fdf343927eddf87be62a6a339c9d /keyboards/kprepublic/bm80/readme.md
parent16c455060849cc07ccff83d7a818420b83d8005a (diff)
parent2742d0c4c119c35980997ee43d9ce0fc412ec250 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/kprepublic/bm80/readme.md')
-rw-r--r--keyboards/kprepublic/bm80/readme.md30
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 0000000000..a0d8e8cf9a
--- /dev/null
+++ b/keyboards/kprepublic/bm80/readme.md
@@ -0,0 +1,30 @@
+# bm80
+
+![bm80](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 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
+
+Flashing example for this keyboard:
+
+ make kprepublic/bm80:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Short the two-pad footprint between the "delete" key and the "end" key while the board is plugged in
+* Press the switch labled RST on the back of the PCB, near the MCU, while the board is plugged in
+* Hold the Esc key while connecting the USB cable (also erases persistent settings)
+
+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.
+
+
+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).
+
+