summaryrefslogtreecommitdiffstats
path: root/keyboards/keychron/q3/readme.md
diff options
context:
space:
mode:
authorlokher <lokher@gmail.com>2022-12-06 17:04:10 +0800
committerlokher <lokher@gmail.com>2022-12-06 17:04:10 +0800
commit27fc28fd2ff52e079a5bc58d6aaea4c752420615 (patch)
tree7ac943fb1ba4f430a7220efd18f66f6a77205c30 /keyboards/keychron/q3/readme.md
parente736133392fe6427cfb995da0787337189828272 (diff)
parent2709b6ed616f8012ff4cfd3ee69a822a8d188351 (diff)
Merge upstream master
Diffstat (limited to 'keyboards/keychron/q3/readme.md')
-rw-r--r--keyboards/keychron/q3/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/keychron/q3/readme.md b/keyboards/keychron/q3/readme.md
new file mode 100644
index 0000000000..8e25a1b332
--- /dev/null
+++ b/keyboards/keychron/q3/readme.md
@@ -0,0 +1,23 @@
+# Keychron Q3
+
+A customizable 80% keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron Q3
+* Hardware Availability: [Keychron](https://www.keychron.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+```
+ make keychron/q3/ansi:default
+```
+
+Flashing example for this keyboard:
+
+```
+ make keychron/q3/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).