diff options
Diffstat (limited to 'keyboards/yampad/readme.md')
| -rw-r--r-- | keyboards/yampad/readme.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/yampad/readme.md b/keyboards/yampad/readme.md new file mode 100644 index 0000000000..e6cc03d60d --- /dev/null +++ b/keyboards/yampad/readme.md @@ -0,0 +1,19 @@ +# Yampad + + + +The Yampad project is an open-source, QMK (Quantum Mechanical Keyboard Firmware) powered, hot-swappable, RGB-backlighted, OLED featured, mechanical numpad. This repository will be used to share information about the project and instruction on how to use and assemble the Yampad. + +* Keyboard Maintainer: [mattdibi](https://github.com/mattdibi) +* Hardware Supported: Pro Micro, (ATmega32u4) +* Hardware Availability: https://github.com/mattdibi/yampad + +Make example for this keyboard (after setting up your build environment): + + make yampad:default + +Flashing example for this keyboard: + + make yampad: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). |