summaryrefslogtreecommitdiff
path: root/keyboards/melgeek/mj6xy/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2022-10-27 09:52:21 -0700
committerGitHub <noreply@github.com>2022-10-27 09:52:21 -0700
commit84569788d59ab01f0dec22aed53450bdfae5230e (patch)
tree7dc8103ad63c670bbc8ad79d56c956396e544934 /keyboards/melgeek/mj6xy/readme.md
parent20ce76f48c4c8c0978b6b78075319b41bb503c76 (diff)
MelGeek MJ6XY Refactor (#18862)
* mj6xy.h: convert tabs to spaces * info.json: convert tabs to spaces * info.json: apply friendly formatting Whitespace-only change. * rename LAYOUT_60_ansi_7u_spc to LAYOUT_60_ansi_tsangan - rename `60_ansi_7u_spc` keymap to `default_ansi_tsangan` * add K31 position to LAYOUT_60_iso * rename LAYOUT_60_iso_7u_spc_split_rshift to LAYOUT_60_iso_tsangan_split_rshift - rename `60_iso_7u_spc_split_rshift` keymap to `default_iso_tsangan_split_rshift` * add K31 position to LAYOUT_60_iso_arrow * add K31 position to LAYOUT_60_iso_arrow_6u_spc * add K31 position to LAYOUT_60_iso_arrow_3u_spc * refactor LAYOUT_60_iso_7u_spc into LAYOUT_60_iso_tsangan - add K31 position to layout macro - rename `60_iso_7u_spc` keymap to `default_iso_tsangan` * add K31 position to LAYOUT_64_iso - rename `64_iso` keymap to `default_64_iso` * add K31 position to LAYOUT_64_iso_3u_spc - rename `64_iso_3u_spc` keymap to `default_64_iso_3u_spc` * add K31 position to LAYOUT_64_iso_split_3u_spc - rename `64_iso_split_3u_spc` keymap to `default_64_iso_split_3u_spc` * remove LAYOUT_60_iso_1u_lshift_split_rshift macro and keymap Functionally identical to `LAYOUT_60_iso_split_rshift`. * remove LAYOUT_60_iso_1u_lshift_7u_spc_split_rshift macro and keymap Functionally identical to `LAYOUT_60_iso_tsangan_split_rshift`. * rename LAYOUT_60_ansi_7u_spc_split_bs to LAYOUT_60_ansi_tsangan_split_bs - rename `60_ansi_7u_spc_split_bs` keymap to `default_60_ansi_tsangan_split_bs` * add K31 position to LAYOUT_60_iso_split_bs * rename LAYOUT_60_iso_7u_spc_split_bs_rshift to LAYOUT_60_iso_tsangan_split_bs_rshift - rename `60_iso_7u_spc_split_bs_rshift` keymap to `default_60_iso_tsangan_split_bs_rshift` * add K31 position to LAYOUT_60_iso_arrow_split_bs * add K31 position to LAYOUT_60_iso_arrow_3u_spc_split_bs - rename `60_iso_arrow_3u_spc_split_bs` keymap to `default_60_iso_arrow_3u_spc_split_bs` * add K31 position to LAYOUT_60_iso_arrow_split_bs_3u_spc - rename `60_iso_arrow_split_bs_3u_spc` keymap to `default_60_iso_arrow_split_bs_3u_spc` * refactor LAYOUT_60_iso_7u_spc_split_bs into LAYOUT_60_iso_tsangan_split_bs - add K31 position to layout macro - rename `60_iso_7u_spc_split_bs` keymap to `default_60_iso_tsangan_split_bs` * add K31 position to LAYOUT_64_iso_split_bs - rename `64_iso_split_bs` keymap to `default_64_iso_split_bs` * add K31 position to LAYOUT_64_iso_3u_spc_split_bs rename `64_iso_3u_spc_split_bs` keymap to `default_64_iso_3u_spc_split_bs` * add K31 position to LAYOUT_64_iso_split_bs_3u_spc - rename `64_iso_split_bs_3u_spc` keymap to `default_64_iso_split_bs_3u_spc` * remove LAYOUT_60_ansi_arrow_6u_spc macro and keymap Functionally identical to `LAYOUT_60_ansi_arrow`. * remove LAYOUT_64_ansi_6u_spc macro and keymap Functionally identical to `LAYOUT_64_ansi`. * remove LAYOUT_60_iso_arrow_6u_spc macro and keymap Functionally identical to `LAYOUT_60_iso_arrow`. * remove LAYOUT_64_iso_6u_spc macro and keymap Functionally identical to `LAYOUT_64_iso`. * remove LAYOUT_60_ansi_arrow_6u_spc_split_bs macro and keymap Functionally identical to `LAYOUT_60_ansi_arrow_split_bs`. * remove LAYOUT_64_ansi_6u_spc_split_bs macro and keymap Functionally identical to `LAYOUT_64_ansi_split_bs`. * remove LAYOUT_60_iso_arrow_6u_spc_split_bs macro and keymap Functionally identical to `LAYOUT_60_iso_arrow_split_bs`. * remove LAYOUT_64_iso_6u_spc_split_bs macro and keymap Functionally identical to `LAYOUT_64_iso_split_bs`. * remove LAYOUT_60_iso_1u_lshift_split_bs_rshift macro and keymap Functionally identical to `LAYOUT_60_iso_split_bs_rshift`. * remove LAYOUT_60_iso_1u_lshift_7u_spc_split_bs_rshift macro and keymap Functionally identical to `LAYOUT_60_iso_tsangan_split_bs_rshift`. * refactor keymaps - convert tabs to spaces - update keycode grid alignment * remove LAYOUT_60_ansi_arrow_3u_spc macro and keymap Subset of `LAYOUT_60_ansi_arrow_3u_spc_split_bs`. * remove LAYOUT_60_iso_arrow_3u_spc macro and keymap Subset of `LAYOUT_60_iso_arrow_3u_spc_split_bs`. * remove LAYOUT_60_iso_tsangan_split_bs macro and keymap Subset of `LAYOUT_60_iso_tsangan_split_bs_rshift`. * remove LAYOUT_60_iso_tsangan_split_rshift macro and keymap Subset of `LAYOUT_60_iso_tsangan_split_bs_rshift`. * remove LAYOUT_64_ansi_3u_spc macro and keymap Subset of `LAYOUT_64_ansi_3u_spc_split_bs`. * remove LAYOUT_64_iso_3u_spc macro and keymap Subset of `LAYOUT_64_iso_3u_spc_split_bs`. * remove LAYOUT_60_iso_split_bs macro and keymap Subset of `LAYOUT_60_iso_split_bs_rshift`. * remove LAYOUT_60_iso_split_rshift macro and keymap Subset of `LAYOUT_60_iso_split_bs_rshift`. * add LAYOUT_60_ansi_split_bs_rshift macro and keymap * remove LAYOUT_60_ansi_split_bs macro and keymap Subset of `LAYOUT_60_ansi_split_bs_rshift`. * add LAYOUT_60_tsangan_hhkb macro and keymap * remove LAYOUT_60_ansi_tsangan_split_bs macro and keymap Subset of `LAYOUT_60_tsangan_hhkb`. * standardize keymap names Rename all keymaps per QMK guidelines (e.g. keymap using `LAYOUT_60_ansi_arrow` should be named `default_60_ansi_arrow`). * add LAYOUT_all; refactor default keymap Add a `LAYOUT_all` macro, and update the `default` keymap to use the new macro. * refactor via keymap Update the `via` keymap to match the behaviour of the `default` keymap. * improve keyboard readme - fix broken image reference - improve grammar on keyboard description - fix Hardware Availability link - fix `make` instructions - add bootloader and flashing instructions * fix default_60_tsangan_hhkb keymap Fix a keycode count mismatch. * mj6xy.h: add matrix diagram * KC_GESC -> QK_GESC per fauxpark * KC_SLCK -> KC_SCRL per fauxpark
Diffstat (limited to 'keyboards/melgeek/mj6xy/readme.md')
-rwxr-xr-xkeyboards/melgeek/mj6xy/readme.md23
1 files changed, 17 insertions, 6 deletions
diff --git a/keyboards/melgeek/mj6xy/readme.md b/keyboards/melgeek/mj6xy/readme.md
index 952f8c4868..bbeffd3179 100755
--- a/keyboards/melgeek/mj6xy/readme.md
+++ b/keyboards/melgeek/mj6xy/readme.md
@@ -1,17 +1,28 @@
# MJ6XY 60% Mechanical Keyboard PCB
-![MJ6XY](https://cdn.shopifycdn.net/s/files/1/0078/2863/5712/products/e66b60bbaa22111cfcb8c9287ff182fa_fe508bda-4e62-4d0e-9842-552ed1233af0_1024x1024@2x.jpg?v=1625753059)
+![MJ6XY rev3](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/melgeek/mj6xy/7084b1fb2e7228c664ee0e481544bd24.webp)
-## A Customizable 60% Mechanical Keyboard PCB which is support multi-layouts
-
-![A Customizable 60% Mechanical Keyboard PCB](https://cdn.shopifycdn.net/s/files/1/0078/2863/5712/products/e66b60bbaa22111cfcb8c9287ff182fa_fe508bda-4e62-4d0e-9842-552ed1233af0_1024x1024@2x.jpg?v=1625753059)
+A customizable 60% Mechanical Keyboard PCB which supports multiple layouts.
* Keyboard Maintainer: QMK Community
* Hardware Supported: MJ6XY 60% Mechanical Keyboard PCB
-* Hardware Availability: [MelGeek](https://www.melgeek.com/collections/pcb-plate/products/melgeek-mj6xy-soldered-pcba-melgeek-com)
+* Hardware Availability: [MelGeek](https://www.melgeek.com/products/melgeek-mj6xy-60-mechanical-keyboard-pcb-melgeek-com)
Make example for this keyboard (after setting up your build environment):
- make melgeek/mj6xy:default
+ make melgeek/mj6xy/rev3:default
+
+Flashing example for this keyboard:
+
+ make melgeek/mj6xy/rev3:default:flash
+
+## Bootloader
+
+To reset the board into bootloader mode, do one of the following:
+
+* **Bootmagic reset**: Hold the key at the top left of the keyboard while connecting the USB cable (also erases persistent settings)
+Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Tap the Reset switch mounted on the bottom side of the PCB (near the QWERTY `S` and `D` keys)
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
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).