qmk_firmware/quantum/template/avr/readme.md

16 lines
668 B
Markdown

# %KEYBOARD%
![%KEYBOARD%](imgur.com image replace me!)
A short description of the keyboard/project
Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
Hardware Supported: The PCBs, controllers supported
Hardware Availability: links to where you can find this hardware
Make example for this keyboard (after setting up your build environment):
make %KEYBOARD%: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).