summaryrefslogtreecommitdiffstats
path: root/keyboards/keychron/q1_pro/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/keychron/q1_pro/readme.md')
-rw-r--r--keyboards/keychron/q1_pro/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/keychron/q1_pro/readme.md b/keyboards/keychron/q1_pro/readme.md
new file mode 100644
index 0000000000..28e4cefc6f
--- /dev/null
+++ b/keyboards/keychron/q1_pro/readme.md
@@ -0,0 +1,21 @@
+# Keychron Q1 Pro
+
+![Keychron Q1 Pro](https://cdn.shopify.com/s/files/1/0059/0630/1017/t/5/assets/keychronq1proqmkviacustommechanicalkeyboard--edited-1669962623486.jpg)
+
+A customizable 81 keys TKL keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron Q1 Pro
+* Hardware Availability: [Keychron Q1 Pro Wireless, Customizeable, QMK/VIA Mechanical Keyboard](https://www.keychron.com/products/keychron-k8-pro-qmk-via-wireless-mechanical-keyboard)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/q1_pro/ansi_konb:default
+
+Flashing example for this keyboard:
+
+ make keychron/q1_pro/ansi_konb: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).