From 87cdb1cf9a89a702f0c4286d4260fc84b18ae042 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Thu, 26 Aug 2021 16:53:24 +0100 Subject: Update readme files (#14172) --- keyboards/xiudi/xd002/readme.md | 2 +- keyboards/xiudi/xd004/readme.md | 17 ++++++++++------- keyboards/xiudi/xd60/readme.md | 4 ++-- keyboards/xiudi/xd68/readme.md | 4 ++-- keyboards/xiudi/xd75/readme.md | 4 ++-- keyboards/xiudi/xd84/readme.md | 12 ++++++------ keyboards/xiudi/xd84pro/readme.md | 4 ++-- keyboards/xiudi/xd87/readme.md | 8 ++++---- keyboards/xiudi/xd96/readme.md | 12 ++++++------ 9 files changed, 35 insertions(+), 32 deletions(-) (limited to 'keyboards/xiudi') diff --git a/keyboards/xiudi/xd002/readme.md b/keyboards/xiudi/xd002/readme.md index 6358bc754e..65522fda2c 100644 --- a/keyboards/xiudi/xd002/readme.md +++ b/keyboards/xiudi/xd002/readme.md @@ -12,7 +12,7 @@ Make example for this keyboard (after setting up your build environment): - make xd002:default + make xiudi/xd002:default 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). diff --git a/keyboards/xiudi/xd004/readme.md b/keyboards/xiudi/xd004/readme.md index 8f858a8411..6ee2fa2cd9 100644 --- a/keyboards/xiudi/xd004/readme.md +++ b/keyboards/xiudi/xd004/readme.md @@ -1,13 +1,12 @@ -XD004 -== +# XD004 4-keys board ![Top View of a XD004 board](https://ae01.alicdn.com/kf/HTB1_G9IX21H3KVjSZFHq6zKppXa0/xd004-xiudi-4-Custom-Mechanical-Keyboard-4-keys-switch-leds-PCB-programmed-hot-swappable-macro-key.jpg) -Keyboard Maintainer: QMK Community -Hardware Supported: XD004 PCB v1.0 -Hardware Availability: [KPRepublic](https://kprepublic.com/products/xd004-xiudi-4-custom-mechanical-keyboard-4-keys-switch-leds-pcb-programmed-hot-swappable-macro-key-silver-case-micro-port) +* Keyboard Maintainer: QMK Community +* Hardware Supported: XD004 PCB v1.0 +* Hardware Availability: [KPRepublic](https://kprepublic.com/products/xd004-xiudi-4-custom-mechanical-keyboard-4-keys-switch-leds-pcb-programmed-hot-swappable-macro-key-silver-case-micro-port) To put this board in DFU (firmware update) mode, bridge the last two pins (#5 & 6) of the 6-pin "J2" header on the opposite edge of the board to the USB port" ``` @@ -23,8 +22,12 @@ To put this board in DFU (firmware update) mode, bridge the last two pins (#5 & ----+ ``` -To build with a default keymap (not useful at all, have a look at other keymaps): +Make example for this keyboard (after setting up your build environment): -```make xd004/v1:default``` + make xiudi/xd004/v1:default + +Flashing example for this keyboard: + + make xiudi/xd004/v1:default:flash 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). diff --git a/keyboards/xiudi/xd60/readme.md b/keyboards/xiudi/xd60/readme.md index f4926d01a5..db03613b8d 100644 --- a/keyboards/xiudi/xd60/readme.md +++ b/keyboards/xiudi/xd60/readme.md @@ -11,7 +11,7 @@ Compact 60% with arrows. Make example for this keyboard (after setting up your build environment): - make xd60/rev2:default # rev2 - make xd60/rev3:default # rev3 + make xiudi/xd60/rev2:default # rev2 + make xiudi/xd60/rev3:default # rev3 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). diff --git a/keyboards/xiudi/xd68/readme.md b/keyboards/xiudi/xd68/readme.md index a62d9c7c56..dd12ad632c 100644 --- a/keyboards/xiudi/xd68/readme.md +++ b/keyboards/xiudi/xd68/readme.md @@ -12,8 +12,8 @@ Make example for this keyboard (after setting up your build environment): - make xd68:default - make xd68:default_iso # default ISO UK layout + make xiudi/xd68:default + make xiudi/xd68:default_iso # default ISO UK layout ## Layouts diff --git a/keyboards/xiudi/xd75/readme.md b/keyboards/xiudi/xd75/readme.md index 65da5cc02a..4b0bf1c3b8 100644 --- a/keyboards/xiudi/xd75/readme.md +++ b/keyboards/xiudi/xd75/readme.md @@ -12,11 +12,11 @@ This port of the QMK firmware is my first shot at using QMK, so if you see any f Make example for this keyboard (after setting up your build environment): - make xd75:default + make xiudi/xd75:default Flashing example for this keyboard: - make xd75:default:flash + make xiudi/xd75:default:flash 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). diff --git a/keyboards/xiudi/xd84/readme.md b/keyboards/xiudi/xd84/readme.md index b8d9c5dbb8..4efedca36b 100644 --- a/keyboards/xiudi/xd84/readme.md +++ b/keyboards/xiudi/xd84/readme.md @@ -8,16 +8,16 @@ Keyboard with 84 Keys & RGB LED Underglow - iso and ansi support - Uses Kimera core -Keyboard Maintainer: QMK Community -Hardware Supported: XD84 -Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-70-custom-keyboard-pcb) +* Keyboard Maintainer: QMK Community +* Hardware Supported: XD84 +* Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-70-custom-keyboard-pcb) Make example for this keyboard (after setting up your build environment): - make xd84:default + make xiudi/xd84:default -Install examples: +Flashing example for this keyboard: - make xd84:default:dfu + make xiudi/xd84:default:flash 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). diff --git a/keyboards/xiudi/xd84pro/readme.md b/keyboards/xiudi/xd84pro/readme.md index 76e83c6c5d..7641a26b75 100644 --- a/keyboards/xiudi/xd84pro/readme.md +++ b/keyboards/xiudi/xd84pro/readme.md @@ -15,10 +15,10 @@ The silkscreen printing on the PCB refers to this as the "XD84 v2.0". Make example for this keyboard (after setting up your build environment): - make xd84pro:default + make xiudi/xd84pro:default Flashing example for this keyboard: - make xd84pro:default:flash + make xiudi/xd84pro:default:flash 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). diff --git a/keyboards/xiudi/xd87/readme.md b/keyboards/xiudi/xd87/readme.md index 0b9389740d..7beae2c6c8 100644 --- a/keyboards/xiudi/xd87/readme.md +++ b/keyboards/xiudi/xd87/readme.md @@ -11,16 +11,16 @@ Make example for this keyboard (after setting up your build environment): - make xd87:default + make xiudi/xd87:default It also supports the tkl_ansi and tkl_iso community layouts: # Build firmware with ANSI layout - make xd87:default_tkl_ansi + make xiudi/xd87:default_tkl_ansi # Build firmware with ISO layout - make xd87:default_tkl_iso + make xiudi/xd87:default_tkl_iso -The keyboard can be reset to bootloader by using bootmagic (space+b by default) or short out the small connector between the Delete and End keys. +The keyboard can be reset to bootloader by using bootmagic (top left key by default) or short out the small connector between the Delete and End keys. 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 diff --git a/keyboards/xiudi/xd96/readme.md b/keyboards/xiudi/xd96/readme.md index bf01db8bb7..5f4038ef3f 100644 --- a/keyboards/xiudi/xd96/readme.md +++ b/keyboards/xiudi/xd96/readme.md @@ -7,16 +7,16 @@ Keyboard with 96 Keys & RGB LED Underglow - ISO and ANSI support - Uses Kimera core -Keyboard Maintainer: QMK Community -Hardware Supported: XD96 -Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd96-pcb-90-custom-mechanical-keyboard-supports-tkg-tools-underglow-rgb-programmed); [AliExpress](https://aliexpress.com/item/cospad-Custom-Mechanical-Keyboard-Kit-up-tp-24-keys-Supports-TKG-TOOLS-Underglow-RGB-PCB-20/32818383873.html) +* Keyboard Maintainer: QMK Community +* Hardware Supported: XD96 +* Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd96-pcb-90-custom-mechanical-keyboard-supports-tkg-tools-underglow-rgb-programmed); [AliExpress](https://aliexpress.com/item/cospad-Custom-Mechanical-Keyboard-Kit-up-tp-24-keys-Supports-TKG-TOOLS-Underglow-RGB-PCB-20/32818383873.html) Make example for this keyboard (after setting up your build environment): - make xd96:default + make xiudi/xd96:default -Install examples: +Flashing example for this keyboard: - make xd96:default:dfu + make xiudi/xd96:default:flash 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). -- cgit v1.2.3