darkkirb/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
qmk_firmware/data/templates/keyboard
History
Joel Challis 936c341ef8
Update info.json
2022-03-05 20:54:51 +00:00
..
config.h Various fixes for new-keyboard (#16358) 2022-02-15 01:42:58 +00:00
info.json Update info.json 2022-03-05 20:54:51 +00:00
readme.md Initial pass at data driven new-keyboard subcommand (#12795) 2022-02-09 06:03:30 +11:00
rules.mk Initial pass at data driven new-keyboard subcommand (#12795) 2022-02-09 06:03:30 +11:00

readme.md

%KEYBOARD%

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

A short description of the keyboard/project

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