diff options
| author | William Chang <william@factual.com> | 2019-11-20 22:17:07 -0800 |
|---|---|---|
| committer | William Chang <william@factual.com> | 2019-11-20 22:17:07 -0800 |
| commit | e7f4d56592b3975c38af329e77b4efd9108495e8 (patch) | |
| tree | 0a416bccbf70bfdbdb9ffcdb3bf136b47378c014 /keyboards/kudox/readme.md | |
| parent | 71493b2f9bbd5f3d18373c518fa14ccafcbf48fc (diff) | |
| parent | 8416a94ad27b3ff058576f09f35f0704a8b39ff3 (diff) | |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'keyboards/kudox/readme.md')
| -rw-r--r-- | keyboards/kudox/readme.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/kudox/readme.md b/keyboards/kudox/readme.md new file mode 100644 index 0000000000..cc97bf83b0 --- /dev/null +++ b/keyboards/kudox/readme.md @@ -0,0 +1,29 @@ +# 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 rev2.0" width="600"/> +</p> + +- Keyboard Maintainer: [Kumao Kobo](https://github.com/kumaokobo) +- Hardware Supported: Kudox PCB rev1.0 rev2.0 w/ Pro Micro + +Make example for this keyboard (after setting up your build environment): + +```sh +make kudox/rev2:default +``` + + +Example of flashing this keyboard: + +```sh +make kudox/rev2:default:flash +``` + +*keymaps/default is for rev2.0. If you want to use rev1.0, you should remove Left-06 key and Right-06 key.* + +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). |