summaryrefslogtreecommitdiff
path: root/keyboards/quarkeys/z40/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-02-16 16:31:05 +0000
committerQMK Bot <hello@qmk.fm>2023-02-16 16:31:05 +0000
commit86ab1c13315db9db5bfd2328bdf7aeb2e858343b (patch)
treec3d865a42508bb3efa3576ceb4401a537fbf3437 /keyboards/quarkeys/z40/readme.md
parent242f51007f2a6151da49cebb0d6ac4aa77fa9e19 (diff)
parentbeb9fcb8bcf156337601499d0b0de5f246878808 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/quarkeys/z40/readme.md')
-rw-r--r--keyboards/quarkeys/z40/readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/keyboards/quarkeys/z40/readme.md b/keyboards/quarkeys/z40/readme.md
new file mode 100644
index 0000000000..d3428dd206
--- /dev/null
+++ b/keyboards/quarkeys/z40/readme.md
@@ -0,0 +1,23 @@
+# Quarkeys Z40 Low Profile Keyboard
+
+![Quarkeys Z40 Pastry](https://raw.githubusercontent.com/tommyamoszhao/keyboardimage/main/Z40/Z40_1024.png)
+
+A 40% Bottom mount low-profile & MX switch compatible keyboard.
+
+* Keyboard Maintainer: [Quarkeys Studio](www.quarkeys.com)
+* Hardware Supported: Z40-ACR, Z40-Pastry
+* Hardware Specs: Per-key RGBs, layer & Capslock indicators
+* For [RGB Matrix feature](https://docs.qmk.fm/#/feature_rgb_matrix): `RGB_MATRIX_ENABLE = yes`, `RGBLIGHT_ENABLE = no`.
+* For [RGB Light feature](https://docs.qmk.fm/#/feature_rgblight): `RGB_MATRIX_ENABLE = no`, `RGBLIGHT_ENABLE = yes`.
+
+Make example for this keyboard solder version keymap(after setting up your build environment):
+
+ make quarkeys/z40:default
+
+Flashing example for this keyboard:
+
+ make quarkeys/z40:default:flash
+
+**Bootloader:** Press the `QK_BOOT` keycode at ESC position of layer 1.
+
+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). \ No newline at end of file