2cade3a483
* Misc folder tidy * Review comments * Remove redundant entry |
||
---|---|---|
.. | ||
config.h | ||
readme.md | ||
rules.mk |
readme.md
%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