summaryrefslogtreecommitdiff
path: root/keyboards/keychron/q2/readme.md
diff options
context:
space:
mode:
authorlalalademaxiya1 <66767061+lalalademaxiya1@users.noreply.github.com>2022-01-15 02:58:09 +0800
committerGitHub <noreply@github.com>2022-01-14 10:58:09 -0800
commitca0f922e073db9804ab0b55c62a43d81a957dce8 (patch)
tree551937bb95a21e264754deb60394dde87e2e4855 /keyboards/keychron/q2/readme.md
parent9e92d8a9054329200661efbc92022af7c67675bb (diff)
downloadqmk_firmware-ca0f922e073db9804ab0b55c62a43d81a957dce8.tar.gz
qmk_firmware-ca0f922e073db9804ab0b55c62a43d81a957dce8.zip
[Keyboard] Add Keychron_q1 rev_0101 and Keychron q2 series (#15025)
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: Cesar Rojas <cesar.fieoner@gmail.com> Co-authored-by: lokher <lokher@gmail.com> Co-authored-by: Adam Karim <adam@akarsoft.com>
Diffstat (limited to 'keyboards/keychron/q2/readme.md')
-rw-r--r--keyboards/keychron/q2/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/keychron/q2/readme.md b/keyboards/keychron/q2/readme.md
new file mode 100644
index 0000000000..bdceb98d48
--- /dev/null
+++ b/keyboards/keychron/q2/readme.md
@@ -0,0 +1,19 @@
+# Keychron Q2
+
+A customizable 65% keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron Q2
+* Hardware Availability: [Keychron](https://www.keychron.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/q2/rev_0110:default
+
+Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
+
+ make keychron/q2/rev_0110: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).