summaryrefslogtreecommitdiffstats
path: root/keyboards/keychron/q3/readme.md
diff options
context:
space:
mode:
authorlalalademaxiya1 <66767061+lalalademaxiya1@users.noreply.github.com>2022-10-13 02:33:44 +0800
committerGitHub <noreply@github.com>2022-10-13 05:33:44 +1100
commitcf749f2dd03a7e04395d9b6862cc11a22c76fb9d (patch)
treee2aa9ebb2667a53daab32e31a595f5b5daef35b3 /keyboards/keychron/q3/readme.md
parentedef8d2a84002059fb32c299499a99e4b9bcf62c (diff)
Keychron q3 (#16912)
Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Cesar Rojas <cesar.fieoner@gmail.com> Co-authored-by: lokher <lokher@gmail.com> Co-authored-by: Adam Karim <adam@akarsoft.com> Co-authored-by: bootstrapper <ido.samuelson@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
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).