qmk_firmware/quantum/template/avr/readme.md

16 lines
670 B
Markdown
Raw Normal View History

2017-11-02 02:10:05 +01:00
# %KEYBOARD%
2015-10-27 19:33:18 +01:00
2017-11-02 02:10:05 +01:00
![%KEYBOARD%](imgur.com image replace me!)
2015-10-27 19:33:18 +01:00
2017-11-02 02:10:05 +01:00
A short description of the keyboard/project
2015-10-30 05:48:17 +01:00
* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
* Hardware Supported: The PCBs, controllers supported
* Hardware Availability: Links to where you can find this hardware
2015-10-30 05:48:17 +01:00
2017-11-02 02:10:05 +01:00
Make example for this keyboard (after setting up your build environment):
2017-11-02 02:14:24 +01:00
make %KEYBOARD%:default
2015-10-30 05:48:17 +01:00
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).