1
0
Fork 0
qmk_firmware/quantum/template/readme.md

15 lines
563 B
Markdown
Raw Normal View History

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