marco/qmk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
7b151143f7
qmk/data/templates/ps2avrgb/readme.md
Mikkel Jeppesen fefd7fdc51
Refactor new-keyboard to be python3.7 compatible (#14707) 
* Use copy_tree from distutils for python 3.7 support

* Bump python version in docs

* Changed new-keyboard to use printf-style format strings

* Use username for manunfacturer / maintainer

* Update lib/python/qmk/cli/new/keyboard.py

Co-authored-by: Zach White <skullydazed@drpepper.org>

Co-authored-by: Zach White <skullydazed@drpepper.org>
2021-11-05 08:14:43 +11:00

1.4 KiB
Raw Blame History

%(KEYBOARD)s

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

A short description of the keyboard/project

  • Keyboard Maintainer: %(YOUR_NAME)s
  • 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)s:default

Flashing example for this keyboard (after setting up the bootloadHID flashing environment)

make %(KEYBOARD)s: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
  • BootloadHID reset: Hold down the key connected to the A0 and B0 pins on the MCU if it is known (often top left or bottom left) 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