mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-19 08:03:22 +00:00
e6cc9cc78d
* Template updates * Flesh out info.json & keymap.c, and turn double spaces section into a list * Add enum to demonstrate layer naming * Semicolon
22 lines
961 B
Markdown
22 lines
961 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
|
|
|
|
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
|
|
|
|
make %KEYBOARD%:default:flash
|
|
|
|
**Reset Key**: Hold down the key located at *LOCATION*, commonly programmed as *KEY* while plugging in the keyboard.
|
|
|
|
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).
|