qmk_firmware/quantum/template/ps2avrgb
MechMerlin ccfe60eb57 Update ps2avrgb readme (#3599)
* give ps2avrgb a specific readme

* add homebrew and crosspack avr step

* update readme of all ps2avrgb boards to reflect the new template
2018-08-09 17:45:43 -07:00
..
config.h
i2c.c
i2c.h
matrix.c
readme.md
rules.mk
template.c
template.h
usbconfig.h

readme.md

%KEYBOARD%

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

A short description of the keyboard/project

Keyboard Maintainer: You
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 python
    brew 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 build environment setup then the make instructions for more information.