From 9587fac72a749e07bcdede40f8059df77a04a3e4 Mon Sep 17 00:00:00 2001
From: x1 <viva008@gmail.com>
Date: Wed, 7 Aug 2019 02:14:40 +0900
Subject: [Keyboard] Add kudox keyboard (#6459)

* Add Kudox Keyboard profile.

* Modified info.json and image link on readme.

* Remove unnecessary codes.

* Set BootLoader caterina.

* Remove duplicated settings on rules.mk.

* Clean up config.h.

* Modified include header path.

* Modified info.json to adjust 4th row keys y position.

* Separate default keymap and my keymap.

* Modified RGB_LED_* settings on kudox/rev1/config.h.
---
 keyboards/kudox/readme.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 keyboards/kudox/readme.md

(limited to 'keyboards/kudox/readme.md')

diff --git a/keyboards/kudox/readme.md b/keyboards/kudox/readme.md
new file mode 100644
index 0000000000..42e1ed9372
--- /dev/null
+++ b/keyboards/kudox/readme.md
@@ -0,0 +1,26 @@
+# The Kudox keyboard
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox.png" alt="Kudox logo" width="600"/>
+</p>
+
+<p align="center">
+<img src="https://raw.githubusercontent.com/kumaokobo/kudox-keyboard/master/img/kudox-pcb.jpg" alt="Kudox PCB rev1.0" width="600"/>
+</p>
+
+- Keyboard Maintainer: [Kumao Kobo](https://github.com/kumaokobo)  
+- Hardware Supported: Kudox PCB rev1.0 w/ Pro Micro  
+
+Make example for this keyboard (after setting up your build environment):
+
+```sh
+make kudox/rev1:default
+```
+
+Example of flashing this keyboard:
+
+```sh
+make kudox/rev1:default:avrdude
+```
+
+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