You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

21 lines
959 B

  1. # %KEYBOARD%
  2. ![%KEYBOARD%](imgur.com image replace me!)
  3. A short description of the keyboard/project
  4. Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
  5. Hardware Supported: The PCBs, controllers supported
  6. Hardware Availability: links to where you can find this hardware
  7. Make example for this keyboard (after setting up your build environment):
  8. make %KEYBOARD%:default
  9. Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
  10. make %KEYBOARD%:default:flash
  11. **Reset Key**: Hold down the key located at *LOCATION*, commonly programmed as *KEY* while plugging in the keyboard.
  12. 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).