summaryrefslogtreecommitdiffstats
path: root/keyboards/playkbtw/pk64rgb/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/playkbtw/pk64rgb/readme.md')
-rw-r--r--keyboards/playkbtw/pk64rgb/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/playkbtw/pk64rgb/readme.md b/keyboards/playkbtw/pk64rgb/readme.md
new file mode 100644
index 0000000000..29871af7a6
--- /dev/null
+++ b/keyboards/playkbtw/pk64rgb/readme.md
@@ -0,0 +1,25 @@
+# Play Keyboard 64RGB
+
+![PK64RGB](https://cdn.store-assets.com/s/409567/i/25281841.png)
+
+A 60% RGB hotswap keyboard PCB made by Play Keyboard.
+
+* Keyboard Maintainer: [Barry Huang](https://github.com/yj7272098)
+* Hardware Supported: Play Keyboard 64 RGB
+* Hardware Availability: [Play Keyboard](http://play-keyboard.store/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make playkbtw/pk64rgb:default
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+You can get into bootloader by pressing the reset button from the back of PCB.
+
+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). \ No newline at end of file