qmk-keychron-q3-colemak-dh/quantum/template/ps2avrgb/readme.md

# %KEYBOARD%

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

A short description of the keyboard/project

Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)  
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](http://vusb.wikidot.com/project: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](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).
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-10 02:45:43 +02:00			`# %KEYBOARD%`

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

			`A short description of the keyboard/project`

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-12 00:39:40 +02:00			`Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)`
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-10 02:45:43 +02:00			`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](http://vusb.wikidot.com/project: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:`
			```
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-12 00:39:40 +02:00			`brew install python3`
			`pip3 install pyusb`
			`brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb`
			```
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-10 02:45:43 +02:00			`4. Place your keyboard into reset.`
			5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.

Updated templates for use by new_project.sh (#3783) * template.h file cleanup Reformatted the pre-macro comments as block comments. Updated the ps2avrgb template comment to match the avr template's comment, which was more informative. Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore. * base template keymap.c refactor Deleted the deprecated TMK macro functions. Defined two custom keycodes for use as macros by process_record_user. process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were. * Removed an extra " from macro command per @drashna * Added BOOTLOADER rule to avr/rules.mk per @drashna * Updated Bootloader sections per @drashna * Updated links to docs at the bottom of both avr and ps2avrgb template readme.md files Corrected the links to the Build Environment Setup and the Make Instructions docs. Added direct link to the QMK Complete Newbs Guide. 2018-08-29 19:57:30 +02:00			`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).`