summaryrefslogtreecommitdiffstats
path: root/keyboards/keychron/q5/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/keychron/q5/readme.md')
-rw-r--r--keyboards/keychron/q5/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/keychron/q5/readme.md b/keyboards/keychron/q5/readme.md
new file mode 100644
index 0000000000..ac59839258
--- /dev/null
+++ b/keyboards/keychron/q5/readme.md
@@ -0,0 +1,19 @@
+# Keychron Q5
+
+A customizable 96% keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron Q5
+* Hardware Availability: [Keychron](https://www.keychron.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/q5/ansi:default
+
+Flashing example for this keyboard:
+
+ make keychron/q5/ansi:default:flash
+
+**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Esc* while plugging in the keyboard.
+
+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).