summaryrefslogtreecommitdiff
path: root/keyboards/darkproject/kd87a_bfg_edition/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/darkproject/kd87a_bfg_edition/readme.md')
-rw-r--r--keyboards/darkproject/kd87a_bfg_edition/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/darkproject/kd87a_bfg_edition/readme.md b/keyboards/darkproject/kd87a_bfg_edition/readme.md
new file mode 100644
index 0000000000..83cc8a923d
--- /dev/null
+++ b/keyboards/darkproject/kd87a_bfg_edition/readme.md
@@ -0,0 +1,24 @@
+# KD87A_BFG_Edition
+![KD87A_BFG_Edition](https://imgur.com/uOUvWvwh.png)
+
+An 87 keys keyboard, Equipped with the WestBerry Q95 microcontroller.
+
+* Keyboard Maintainer: [GSKY](https://github.com/gksygithub)
+* Hardware Supported: KD87A_BFG_Edition
+* Hardware Availability: [GSKY GitHub](https://github.com/gksygithub/keyboard1)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make darkproject/kd87a_bfg_edition:default
+
+Flashing example for this keyboard:
+
+ make darkproject/kd87a_bfg_edition:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Hold the Reset switch mounted on the surface of the PCB back side after the USB cable is connected
+* Hold the Escape key while connecting the USB cable (also erases persistent settings)
+* Fn+ESC will reset the board to bootloader mode
+
+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).