2021-11-04 22:14:43 +01:00
# %(KEYBOARD)s
2015-10-27 19:33:18 +01:00
2021-11-04 22:14:43 +01:00
![%(KEYBOARD)s ](imgur.com image replace me! )
2015-10-27 19:33:18 +01:00
2020-07-15 10:52:02 +02:00
*A short description of the keyboard/project*
2015-10-30 05:48:17 +01:00
2021-11-04 22:14:43 +01:00
* Keyboard Maintainer: [%(YOUR_NAME)s ](https://github.com/%(USER_NAME )s)
2020-07-15 10:52:02 +02:00
* 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-09-08 19:47:50 +02:00
2021-11-04 22:14:43 +01:00
make %(KEYBOARD)s:default
2015-10-30 05:48:17 +01:00
2020-07-15 10:52:02 +02:00
Flashing example for this keyboard:
2021-11-04 22:14:43 +01:00
make %(KEYBOARD)s:default:flash
2020-07-15 10:52:02 +02:00
2018-08-29 19:57:30 +02: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 ).
2021-08-04 02:23:18 +02: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
* **Keycode in layout**: Press the key mapped to `RESET` if it is available