summaryrefslogtreecommitdiffstats
path: root/keyboards/cherrybstudio/cb87rgb/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/cherrybstudio/cb87rgb/readme.md')
-rw-r--r--keyboards/cherrybstudio/cb87rgb/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/cherrybstudio/cb87rgb/readme.md b/keyboards/cherrybstudio/cb87rgb/readme.md
new file mode 100644
index 0000000000..f7c9985d8c
--- /dev/null
+++ b/keyboards/cherrybstudio/cb87rgb/readme.md
@@ -0,0 +1,26 @@
+# CherryB Studio CB87RGB
+
+![cb87rgb](https://i.imgur.com/wG1qS4I.jpg)
+
+A RGB TKL PCB including hotswap and solderable variant for CherryB Studio NEO87 and many compatible TKLs
+
+* Keyboard Maintainer: duongaanh
+* Hardware Supported: cb87rgb, atmega32u4
+* Hardware Availability: [CherryB Studio](https://discord.gg/3gsCa8K)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cherrybstudio/cb87rgb:default
+
+Flashing example for this keyboard:
+
+ make cherrybstudio/cb87rgb:default:flash
+
+## Accessing Bootloader Mode
+
+To access Bootloader Mode, do one of the following:
+
+* Tap the Reset switch mounted on the top side of the PCB to the left of the spacebar
+* Hold the top left key of the keyboard while connecting the USB cable
+
+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).