diff options
| author | Joel Challis <git@zvecr.com> | 2021-08-26 16:53:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-26 16:53:24 +0100 |
| commit | 87cdb1cf9a89a702f0c4286d4260fc84b18ae042 (patch) | |
| tree | 948cbe686ee52b222ef3e4818c19260997bdbfb1 /keyboards/xiudi/xd004/readme.md | |
| parent | 48d0ad28e789abae0413002f9dbda38f1a82924a (diff) | |
Update readme files (#14172)
Diffstat (limited to 'keyboards/xiudi/xd004/readme.md')
| -rw-r--r-- | keyboards/xiudi/xd004/readme.md | 17 |
1 files changed, 10 insertions, 7 deletions
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  -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). |