]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/template/ps2avrgb/readme.md
3dce0e950570d7ced8ed4ebeee77cd3c4ba25885
[qmk_firmware.git] / 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 example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
16
17     make %KEYBOARD%:default:flash
18
19 **Reset Key**: Hold down the key located at *LOCATION*, commonly programmed as *KEY* while plugging in the keyboard.
20
21 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).