quantum/template/ps2avrgb/readme.md

   1 # %KEYBOARD%
   2
   3 ![%KEYBOARD%](imgur.com image replace me!)
   4
   5 A short description of the keyboard/project
   6
   7 Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
   8 Hardware Supported: The PCBs, controllers supported
   9 Hardware Availability: links to where you can find this hardware
  10
  11 Make example for this keyboard (after setting up your build environment):
  12
  13     make %KEYBOARD%:default
  14
  15 Flashing
  16
  17 ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
  18
  19 **Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.
  20
  21 Windows:
  22 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
  23 2. Place your keyboard into reset.
  24 3. Press the `Find Device` button and ensure that your keyboard is found.
  25 4. Press the `Open .hex File` button and locate the `.hex` file you created.
  26 5. Press the `Flash Device` button and wait for the process to complete.
  27
  28 macOS:
  29 1. Install homebrew by typing the following:
  30     ```
  31     /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  32     ```
  33 2. Install `crosspack-avr`.
  34     ```
  35     brew cask install crosspack-avr
  36     ```
  37 3. Install the following packages:
  38     ```
  39     brew install python3
  40     pip3 install pyusb
  41     brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  42     ```
  43 4. Place your keyboard into reset.
  44 5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
  45
  46 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).