summaryrefslogtreecommitdiff
path: root/keyboards/xd004/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/xd004/readme.md')
-rw-r--r--keyboards/xd004/readme.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/keyboards/xd004/readme.md b/keyboards/xd004/readme.md
new file mode 100644
index 0000000000..8b32c6a48c
--- /dev/null
+++ b/keyboards/xd004/readme.md
@@ -0,0 +1,16 @@
+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)
+
+To build with a default keymap (not useful at all, have a look at other keymaps):
+
+```make xd004/v1: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).