summaryrefslogtreecommitdiff
path: root/keyboards/keychron/v6/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-02-02 21:34:50 +0000
committerQMK Bot <hello@qmk.fm>2023-02-02 21:34:50 +0000
commit8c0267c0eb51fa3bdcba5643ca70e293439acbf9 (patch)
tree4b695be1ca0223dac50ff90aa0fa7c4fe87bc0a8 /keyboards/keychron/v6/readme.md
parent007bcb21069d69e1371be835721b690d0339e231 (diff)
parentde6a6f963b5e459e8853d83723651bc01774501d (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/keychron/v6/readme.md')
-rw-r--r--keyboards/keychron/v6/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/keychron/v6/readme.md b/keyboards/keychron/v6/readme.md
new file mode 100644
index 0000000000..d8a68846bd
--- /dev/null
+++ b/keyboards/keychron/v6/readme.md
@@ -0,0 +1,19 @@
+# Keychron V6
+
+A customizable 100% keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron V6
+* Hardware Availability: [Keychron](https://www.keychron.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/v6/v6_ansi_stm32l432:default
+
+Flashing example for this keyboard:
+
+ make keychron/v6/v6_ansi_stm32l432: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).