summaryrefslogtreecommitdiffstats
path: root/keyboards/bm68rgb/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/bm68rgb/readme.md')
-rw-r--r--keyboards/bm68rgb/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/bm68rgb/readme.md b/keyboards/bm68rgb/readme.md
new file mode 100644
index 0000000000..4087fd8664
--- /dev/null
+++ b/keyboards/bm68rgb/readme.md
@@ -0,0 +1,24 @@
+# bm68rgb
+
+![bm68rgb](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 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 bm68rgb:default
+
+Flashing example for this keyboard:
+
+ make bm68rgb:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Short the two-pad footprint to the left of the spacebar switch while the board is plugged in
+* Hold the Esc key while connecting the USB cable (also erases persistent settings)
+
+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).