qmk_firmware/data/templates/keyboard/readme.md

# %KEYBOARD%

![%KEYBOARD%](imgur.com image replace me!)

*A short description of the keyboard/project*

* Keyboard Maintainer: [%REAL_NAME%](https://github.com/%USER_NAME%)
* 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

Flashing example for this keyboard:

    make %KEYBOARD%:default:flash

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).

## Bootloader

Enter the bootloader in 3 ways:

* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
Initial pass at data driven new-keyboard subcommand (#12795) * Initial pass at a data driven keyboard subcommand * format * lint * Handle bootloader now its mandatory 2022-02-08 11:03:30 -08:00			`# %KEYBOARD%`
new project script 2015-10-27 11:33:18 -07:00
Initial pass at data driven new-keyboard subcommand (#12795) * Initial pass at a data driven keyboard subcommand * format * lint * Handle bootloader now its mandatory 2022-02-08 11:03:30 -08:00			`![%KEYBOARD%](imgur.com image replace me!)`
new project script 2015-10-27 11:33:18 -07:00
Update new keyboard templates (#9636) * Update new keyboard templates * Switch on Bootmagic Lite by default * Remove MIDI_ENABLE and FAUXCLICKY_ENABLE 2020-07-15 01:52:02 -07:00			`A short description of the keyboard/project`
atomic up-to-date 2015-10-29 21:48:17 -07:00
Initial pass at data driven new-keyboard subcommand (#12795) * Initial pass at a data driven keyboard subcommand * format * lint * Handle bootloader now its mandatory 2022-02-08 11:03:30 -08:00			`* Keyboard Maintainer: [%REAL_NAME%](https://github.com/%USER_NAME%)`
Update new keyboard templates (#9636) * Update new keyboard templates * Switch on Bootmagic Lite by default * Remove MIDI_ENABLE and FAUXCLICKY_ENABLE 2020-07-15 01:52:02 -07:00			`* Hardware Supported: The PCBs, controllers supported`
			`* Hardware Availability: Links to where you can find this hardware`
atomic up-to-date 2015-10-29 21:48:17 -07:00
update qmk template 2017-11-01 18:10:05 -07:00			`Make example for this keyboard (after setting up your build environment):`
Remove all Makefiles from the keyboards directory. (#1660) * Remove all Makefiles from the keyboards directory. * update keymaps added in the last 8 days * Ignore keyboard/keymap makefiles * update hand_wire to reflect our new Makefile-less reality * Update the make guide to reflect the new reality * move planck keymap options to rules.mk * update planck keymaps 4real * trigger travis * add back build_keyboard.mk * restore changes to build_keyboard 2017-09-08 10:47:50 -07:00
Initial pass at data driven new-keyboard subcommand (#12795) * Initial pass at a data driven keyboard subcommand * format * lint * Handle bootloader now its mandatory 2022-02-08 11:03:30 -08:00			`make %KEYBOARD%:default`
atomic up-to-date 2015-10-29 21:48:17 -07:00
Update new keyboard templates (#9636) * Update new keyboard templates * Switch on Bootmagic Lite by default * Remove MIDI_ENABLE and FAUXCLICKY_ENABLE 2020-07-15 01:52:02 -07:00			`Flashing example for this keyboard:`

Initial pass at data driven new-keyboard subcommand (#12795) * Initial pass at a data driven keyboard subcommand * format * lint * Handle bootloader now its mandatory 2022-02-08 11:03:30 -08:00			`make %KEYBOARD%:default:flash`
Update new keyboard templates (#9636) * Update new keyboard templates * Switch on Bootmagic Lite by default * Remove MIDI_ENABLE and FAUXCLICKY_ENABLE 2020-07-15 01:52:02 -07:00
Updated templates for use by new_project.sh (#3783) * template.h file cleanup Reformatted the pre-macro comments as block comments. Updated the ps2avrgb template comment to match the avr template's comment, which was more informative. Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore. * base template keymap.c refactor Deleted the deprecated TMK macro functions. Defined two custom keycodes for use as macros by process_record_user. process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were. * Removed an extra " from macro command per @drashna * Added BOOTLOADER rule to avr/rules.mk per @drashna * Updated Bootloader sections per @drashna * Updated links to docs at the bottom of both avr and ps2avrgb template readme.md files Corrected the links to the Build Environment Setup and the Make Instructions docs. Added direct link to the QMK Complete Newbs Guide. 2018-08-29 10:57:30 -07: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).`
Add bootloader section to keyboard template (#13774) * Add bootloader section to keyboard template * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com> 2021-08-03 17:23:18 -07:00
			`## Bootloader`

			`Enter the bootloader in 3 ways:`

			`* Bootmagic reset: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard`
			`* Physical reset button: Briefly press the button on the back of the PCB - some may have pads you must short instead`
RESET -> QK_BOOT keyboard readme (#18110) 2022-08-20 03:34:17 -07:00			* Keycode in layout: Press the key mapped to `QK_BOOT` if it is available