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.

28 lines
1.4 KiB

  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. 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).
  12. ## Bootloader
  13. Enter the bootloader in 3 ways:
  14. * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
  15. * **BootloadHID reset**: Hold down the key connected to the `A0` and `B0` pins on the MCU if it is known (often top left or bottom left) and plug in the keyboard
  16. * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
  17. * **Keycode in layout**: Press the key mapped to `RESET` if it is available