~ruther/qmk_firmware

ref: 7b838f330f11a2dd3ffb49b2ffbea48020004b7c qmk_firmware/data/templates/keyboard/readme.md -rw-r--r-- 1.1 KiB
7b838f33 — Duncan Sutherland add tkl_(ansi|iso)_wkl* community layouts (#21809) 1 year, 1 day ago

#%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
Do not follow this link