aboutsummaryrefslogtreecommitdiff
path: root/keyboards/quarkeys/z40/readme.md
diff options
context:
space:
mode:
authorJames Young <[email protected]>2023-06-21 19:11:32 -0700
committerGitHub <[email protected]>2023-06-21 19:11:32 -0700
commit33f76d79d41115f7d2a77fff355f5d85d3c4155b (patch)
treedd9da2a0ce0fce382d7836e655c4a1b9c2d06674 /keyboards/quarkeys/z40/readme.md
parentb8a12db1a1608349476b03fc9f193c325f1159c3 (diff)
downloadqmk_firmware-33f76d79d41115f7d2a77fff355f5d85d3c4155b.tar.gz
qmk_firmware-33f76d79d41115f7d2a77fff355f5d85d3c4155b.zip
Quarkeys Z40 Community Layout Support and Touch-Up (#21329)
* [refactor] rename LAYOUT to LAYOUT_planck_mit * [style] friendly-format info.json * [style] refactor keymaps - grid-align keycodes - use four-space indent - remove trailing whitespace * [chore] tidy-up keyboard data in info.json - spell-check `manufacturer` value - use valid `url` - reference GitHub username for `maintainer` * [chore] tidy-up readme - link to maintainer's GitHub account - add Hardware Availability link - break-out Hardware Specs into its own section * [enhancement] enable Community Layout support * [chore] replace product image in readme Source repository for previous URL seems to have been deleted.
Diffstat (limited to 'keyboards/quarkeys/z40/readme.md')
-rw-r--r--keyboards/quarkeys/z40/readme.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/keyboards/quarkeys/z40/readme.md b/keyboards/quarkeys/z40/readme.md
index d3428dd206..b1f2bb42be 100644
--- a/keyboards/quarkeys/z40/readme.md
+++ b/keyboards/quarkeys/z40/readme.md
@@ -1,14 +1,18 @@
# Quarkeys Z40 Low Profile Keyboard
-![Quarkeys Z40 Pastry](https://raw.githubusercontent.com/tommyamoszhao/keyboardimage/main/Z40/Z40_1024.png)
+![Quarkeys Z40 Pastry](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/quarkeys/z40/72b918_ef3d9bc5f32e4b2ba224b0a25bc017f4~mv2.png "Quarkeys Z40 PCB render")
A 40% Bottom mount low-profile & MX switch compatible keyboard.
-* Keyboard Maintainer: [Quarkeys Studio](www.quarkeys.com)
+* Keyboard Maintainer: [TommyZ](https://github.com/tommyamoszhao)
* 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`.
+* Hardware Availability: [Quarkeys Studio](https://www.quarkeys.com/product-page/z40-extra-pcb)
+
+## 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):
@@ -20,4 +24,4 @@ Flashing example for this keyboard:
**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
+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).