summaryrefslogtreecommitdiff
path: root/keyboards/keychron/v5/readme.md
diff options
context:
space:
mode:
authorlalalademaxiya1 <66767061+lalalademaxiya1@users.noreply.github.com>2022-12-19 16:53:51 +0800
committerGitHub <noreply@github.com>2022-12-19 19:53:51 +1100
commit4a0027d4933302e0c6ff89d37da83889f466b1b9 (patch)
treefc129d1ee1f5ff8861172edc6325940e1b33a8bd /keyboards/keychron/v5/readme.md
parent359caf1432db284df190b5cac6c16374a2140918 (diff)
Add Keychron V5 (#19320)
Diffstat (limited to 'keyboards/keychron/v5/readme.md')
-rw-r--r--keyboards/keychron/v5/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/keychron/v5/readme.md b/keyboards/keychron/v5/readme.md
new file mode 100644
index 0000000000..2fac219f2c
--- /dev/null
+++ b/keyboards/keychron/v5/readme.md
@@ -0,0 +1,19 @@
+# Keychron V5
+
+A customizable 96% keyboard.
+
+* Keyboard Maintainer: [Keychron](https://github.com/keychron)
+* Hardware Supported: Keychron V5
+* Hardware Availability: [Keychron](https://www.keychron.com)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keychron/v5/ansi:default
+
+Flashing example for this keyboard:
+
+ make keychron/v5/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).