keychron_qmk_firmware/quantum/template/avr/readme.md

15 lines
563 B
Markdown
Raw Normal View History

2017-11-02 07:10:05 +06:00
# %KEYBOARD%
2015-10-28 00:33:18 +06:00
2017-11-02 07:10:05 +06:00
![%KEYBOARD%](imgur.com image replace me!)
2015-10-28 00:33:18 +06:00
2017-11-02 07:10:05 +06:00
A short description of the keyboard/project
2015-10-30 10:48:17 +06:00
2017-11-02 07:10:05 +06:00
Keyboard Maintainer: [You](https://github.com/yourusername)
2017-11-02 07:14:24 +06:00
Hardware Supported: The PCBs, controllers supported
2017-11-02 07:10:05 +06:00
Hardware Availability: links to where you can find this hardware
2015-10-30 10:48:17 +06:00
2017-11-02 07:10:05 +06:00
Make example for this keyboard (after setting up your build environment):
2017-11-02 07:14:24 +06:00
make %KEYBOARD%:default
2015-10-30 10:48:17 +06:00
2017-11-02 07:10:05 +06:00
See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.