mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-18 09:55:48 +00:00
fefd7fdc51
* Use copy_tree from distutils for python 3.7 support * Bump python version in docs * Changed new-keyboard to use printf-style format strings * Use username for manunfacturer / maintainer * Update lib/python/qmk/cli/new/keyboard.py Co-authored-by: Zach White <skullydazed@drpepper.org> Co-authored-by: Zach White <skullydazed@drpepper.org>
27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
# %(KEYBOARD)s
|
|
|
|
|
|
|
|
*A short description of the keyboard/project*
|
|
|
|
* Keyboard Maintainer: [%(YOUR_NAME)s](https://github.com/%(USER_NAME)s)
|
|
* 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)s:default
|
|
|
|
Flashing example for this keyboard:
|
|
|
|
make %(KEYBOARD)s: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 `RESET` if it is available
|