aboutsummaryrefslogtreecommitdiff
path: root/keyboards/mechboards/crkbd/pro/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/mechboards/crkbd/pro/readme.md')
-rw-r--r--keyboards/mechboards/crkbd/pro/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/mechboards/crkbd/pro/readme.md b/keyboards/mechboards/crkbd/pro/readme.md
new file mode 100644
index 0000000000..52fc199d5c
--- /dev/null
+++ b/keyboards/mechboards/crkbd/pro/readme.md
@@ -0,0 +1,25 @@
+# CRKBD Pro
+
+A refreshed CRKBD (Corne) PCB with RGB, battery, power switch and encoder support.
+
+* Keyboard Maintainer: [dasky](https://github.com/daskygit)
+* Hardware Supported: Controllers using promicro footprint.
+* Hardware Availability: https://mechboards.co.uk
+
+Make example for this keyboard (after setting up your build environment):
+
+ qmk compile -kb mechboards/crkbd/pro -km default
+
+Flashing example for this keyboard:
+
+ qmk flash -kb mechboards/crkbd/pro -km default
+
+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 3 ways:
+
+* **Bootmagic reset**: Hold down the top left key/encoder or the top right key/encoder depending on which side you're connecting to usb.
+* **Physical reset button**: Double press the button below the TRRS socket.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available