summaryrefslogtreecommitdiffstats
path: root/keyboards/keychron/q5_pro/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/keychron/q5_pro/readme.md')
-rwxr-xr-xkeyboards/keychron/q5_pro/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/keychron/q5_pro/readme.md b/keyboards/keychron/q5_pro/readme.md
new file mode 100755
index 0000000000..95cd22f342
--- /dev/null
+++ b/keyboards/keychron/q5_pro/readme.md
@@ -0,0 +1,23 @@
+# Keychron Q5 Pro
+
+![Keychron Q5 Pro](https://i.imgur.com/3z9mMMI.jpg)
+
+A wireless custom mechanical 96% keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron Q5 Pro
+* Hardware Availability:[Keychron Q5 Pro QMK/VIA Wireless Custom Mechanical Keyboard](https://www.keychron.com/products/keychron-q5-pro-qmk-via-wireless-custom-mechanical-keyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/q5_pro/ansi_encoder:default
+ make keychron/q5_pro/iso_encoder:default
+
+Flashing example for this keyboard:
+
+ make keychron/q5_pro/ansi_encoder:default:flash
+ make keychron/q5_pro/iso_encoder:default:flash
+
+**Reset Key**: Connect the USB cable, toggle mode switch to "Off", hold down the *Esc* key or reset button underneath space bar, then toggle then switch to "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).