summaryrefslogtreecommitdiff
path: root/keyboards/kprepublic/bm980hsrgb/readme.md
diff options
context:
space:
mode:
authorpeepeetee <43021794+peepeetee@users.noreply.github.com>2021-12-25 09:47:21 +0800
committerGitHub <noreply@github.com>2021-12-24 17:47:21 -0800
commite1303a30d23e6ffb782d76cada2c144c2094f1f7 (patch)
tree232a4b5635f81797ee5cb7678886645369194306 /keyboards/kprepublic/bm980hsrgb/readme.md
parent36db7457b299d91f665f931a5f60bd059ada0210 (diff)
[Keyboard] Add KPrepublic bm980hsrgb support (#14724)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/kprepublic/bm980hsrgb/readme.md')
-rw-r--r--keyboards/kprepublic/bm980hsrgb/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/kprepublic/bm980hsrgb/readme.md b/keyboards/kprepublic/bm980hsrgb/readme.md
new file mode 100644
index 0000000000..13e061e6d5
--- /dev/null
+++ b/keyboards/kprepublic/bm980hsrgb/readme.md
@@ -0,0 +1,30 @@
+# BM980HSRGB
+
+![BM980HSRGB](https://i.imgur.com/k4NQGLxh.jpeg)
+
+A 1800, hotswap, in switch RGB keyboard from KPRepublic.
+
+* Keyboard Maintainer: [peepeetee](https://github.com/peepeetee)
+* Hardware Supported: BM980HSRGB
+* Hardware Availability:
+ * https://kprepublic.com/products/bm980rgb-bm980-rgb-hot-swappable-custom-mechanical-keyboard-pcb-programmed-qmk-via-firmware-full-rgb-switch-underglow-type-c
+ * https://www.aliexpress.com/item/1005002509519466.html
+ * https://item.taobao.com/item.htm?id=645862298692
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kprepublic/bm980hsrgb:default
+
+Flashing example for this keyboard:
+
+ make kprepublic/bm980hsrgb: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).
+
+## Bootloader
+
+Enter the bootloader in one of 3 ways:
+
+* Short the two-pad footprint beneath the f12 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)