mirrors/qmk_firmware
1
0
Fork 1
mirror of https://github.com/qmk/qmk_firmware synced 2024-11-16 08:56:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
qmk_firmware/data/templates/avr/readme.md
Joel Challis 2cade3a483
Align some quantum sub-directories (#14134) 
* Misc folder tidy

* Review comments

* Remove redundant entry
2021-08-24 17:07:11 +01:00

1.1 KiB
Raw Blame History

%KEYBOARD%

![%KEYBOARD%](imgur.com image replace me!)

A short description of the keyboard/project

  • Keyboard Maintainer: %YOUR_NAME%
  • 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:

make %KEYBOARD%:default:flash

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

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