qmk_firmware/data/templates/keyboard/readme.md

28 lines
1.1 KiB
Markdown
Raw Normal View History

# %KEYBOARD%
2015-10-27 19:33:18 +01:00
![%KEYBOARD%](imgur.com image replace me!)
2015-10-27 19:33:18 +01:00
*A short description of the keyboard/project*
2015-10-30 05:48:17 +01:00
* 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*
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):
make %KEYBOARD%:default
2015-10-30 05:48:17 +01:00
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