summaryrefslogtreecommitdiff
path: root/keyboards/keychron/q10/readme.md
diff options
context:
space:
mode:
authorlalalademaxiya1 <66767061+lalalademaxiya1@users.noreply.github.com>2022-12-13 04:10:32 +0800
committerGitHub <noreply@github.com>2022-12-13 07:10:32 +1100
commit1431f314a446685089c390d01d19c73fd7ff5cee (patch)
treed4241d4c8f50b4f830313f030725074b0c113432 /keyboards/keychron/q10/readme.md
parentbf2ed0174bb2c9e60555e41f682cae25b6e4dde7 (diff)
Add Keychron Q10 (#19127)
Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'keyboards/keychron/q10/readme.md')
-rw-r--r--keyboards/keychron/q10/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/keychron/q10/readme.md b/keyboards/keychron/q10/readme.md
new file mode 100644
index 0000000000..ad3c5ebf41
--- /dev/null
+++ b/keyboards/keychron/q10/readme.md
@@ -0,0 +1,19 @@
+# Keychron Q10
+
+A customizable 75% ergonomic keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron Q10
+* Hardware Availability: [Keychron](https://www.keychron.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/q10/ansi_encoder:default
+
+Flashing example for this keyboard:
+
+ make keychron/q10/ansi_encoder:default:flash
+
+**Reset Key**: Hold down the key located at *K01*, which 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).