summaryrefslogtreecommitdiff
path: root/keyboards/cherrybstudio/cb87/readme.md
diff options
context:
space:
mode:
authorDuong Anh <56441863+duongaanh@users.noreply.github.com>2021-04-03 04:25:44 +0700
committerGitHub <noreply@github.com>2021-04-02 14:25:44 -0700
commit43d74d7fa597572677ff79f8213d0ea23f20fc83 (patch)
treeae6eb210fc863f2b6370c436cf3f15853b227814 /keyboards/cherrybstudio/cb87/readme.md
parentcd981ec56a546a29f30c3cc1ce1f5ef2934bc9cd (diff)
[Keyboard] Add CherryB Studio Keyboards (#11475)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Diffstat (limited to 'keyboards/cherrybstudio/cb87/readme.md')
-rw-r--r--keyboards/cherrybstudio/cb87/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/cherrybstudio/cb87/readme.md b/keyboards/cherrybstudio/cb87/readme.md
new file mode 100644
index 0000000000..72bd8c32fa
--- /dev/null
+++ b/keyboards/cherrybstudio/cb87/readme.md
@@ -0,0 +1,26 @@
+# CherryB Studio CB87
+
+![CB87](https://i.imgur.com/balJ20Xl.png)
+
+A TKL PCB for CherryB Studio Freyr and replacement for some TKL keyboards.
+
+* Keyboard Maintainer: duongaanh
+* Hardware Supported: CB87, atmega32u4
+* Hardware Availability: [CherryB Studio](https://www.reddit.com/r/mechmarket/comments/kkgs6p/gb_freyr_tkl_cb_edition_holiday_preorder/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make cherrybstudio/cb87:default
+
+Flashing example for this keyboard:
+
+ make cherrybstudio/cb87: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).