qmk-dactyl-manuform-a/quantum/template/ps2avrgb
noroadsleft 2df82514ab Update ps2avrgb readme template (#5584)
- fix markdown formatting on macOS instructions (close code block)
- update package install commands
  - set python3
  - use pip3 to install pyusb
  - fix typo (extra backtick on bootloadhid package install line)
- update Keyboard Maintainer line (now unified with AVR template)
2019-04-11 15:39:40 -07:00
..
config.h
readme.md Update ps2avrgb readme template (#5584) 2019-04-11 15:39:40 -07:00
rules.mk
template.c
usbconfig.h

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

ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.

Windows:

  1. Download HIDBootFlash.
  2. Place your keyboard into reset.
  3. Press the Find Device button and ensure that your keyboard is found.
  4. Press the Open .hex File button and locate the .hex file you created.
  5. Press the Flash Device button and wait for the process to complete.

macOS:

  1. Install homebrew by typing the following:
    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    
  2. Install crosspack-avr.
    brew cask install crosspack-avr
    
  3. Install the following packages:
    brew install python3
    pip3 install pyusb
    brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
    
  4. Place your keyboard into reset.
  5. Flash the board by typing bootloadHID -r followed by the path to your .hex file.

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.