mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-11 22:44:56 +00:00
0d936b2fe6
* Ask for your name when generating a new keyboard * Update docs * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com>
15 lines
668 B
Markdown
15 lines
668 B
Markdown
# %KEYBOARD%
|
|
|
|
|
|
|
|
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).
|