diff options
Diffstat (limited to 'keyboards/kudox/readme.md')
| -rw-r--r-- | keyboards/kudox/readme.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/kudox/readme.md b/keyboards/kudox/readme.md new file mode 100644 index 000000000..42e1ed937 --- /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). |