marco/qmk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
c2bc6e2b3c
qmk/data/templates/keyboard
History
Joel Challis 3ffe8d917a
Fix 'qmk new-keyboard' processing of development_board (#23996)
2024-06-30 03:39:49 +01:00
..
keyboard.json Fix 'qmk new-keyboard' processing of development_board (#23996) 2024-06-30 03:39:49 +01:00
readme.md RESET -> QK_BOOT keyboard readme (#18110) 2022-08-20 11:34:17 +01: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 QK_BOOT if it is available