Align use of atmega32a program script (#5259)

[qmk_firmware.git] / keyboards / ps2avrGB / README.md

diff --git a/keyboards/ps2avrGB/README.md b/keyboards/ps2avrGB/README.md
index f8360aec0c7c13a93ce2e0c99b8a86ed479dffd9..8a558b158676ed493ff28dd2a1838f2c202851c2 100644 (file)
--- a/keyboards/ps2avrGB/README.md
+++ b/keyboards/ps2avrGB/README.md
@@ -10,11 +10,15 @@ Note that this is a complete replacement for the firmware, so you won't be
 using Bootmapper Client to change any keyboard settings, since not all the
 USB report options are supported.
 
+This is an example based on the b.mini keyboard for making other keyboards
+compatible with QMK; fully supported boards have their own directory.
+
 ## Supported Boards
 
-Only the [B.mini X2](http://winkeyless.kr/product/b-mini-x2-pcb/) has been
-tested so far (since it's the only one I own). But other boards that use
-the ps2avrGB firmware should work as well.
+- [b.fake](https://github.com/qmk/qmk_firmware/tree/master/keyboards/bfake)
+- [b.mini](https://github.com/qmk/qmk_firmware/tree/master/keyboards/bmini)
+- [b.face](https://github.com/qmk/qmk_firmware/tree/master/keyboards/bface)
+- [pearl](https://github.com/qmk/qmk_firmware/tree/master/keyboards/pearl)
 
 ## Installing
 
@@ -26,7 +30,7 @@ $ brew cask install crosspack-avr
 $ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
 ```
 
-In order to use the `./program` script, which can reboot the board into
+In order to use the `./util/atmega32a_program.py` script, which can reboot the board into
 the bootloader, you'll need Python 2 with PyUSB installed:
 
 ```
@@ -37,7 +41,7 @@ Then, with the keyboard plugged in, simply run this command from the
 `qmk_firmware` directory:
 
 ```
-$ make ps2avrGB-program
+$ make ps2avrGB:program
 ```
 
 If you prefer, you can just build it and flash the firmware directly with
@@ -49,13 +53,26 @@ $ make ps2avrGB
 $ bootloadHID -r ps2avrGB_default.hex
 ```
 
+## Setting the board to bootloader mode
+
+If you're lucky, the programming script does this automagically for you. If
+however this doesn't work for you, you need to enter the bootloader mode manually
+by plugging the keyboard in while holding the bootloader key. If you did this
+correctly the LEDs will blink and you'll be able to flash your firmware.
+
+The bootloader key is the top left key of your matrix. For a standard board
+from winkeyless.kr this is `L_Ctrl`, but for some custom boards running ps2avrGB
+this might be different. For the Pearl it's `Esc`, for a b.fake it is `q`. If 
+you're unsure you should be able to see the key in the bootmapper client.
+
+
 ## Troubleshooting
 
 From my experience, it's really hard to brick these boards. But these
 tricks have been useful when it got stuck in a weird scenario.
 
-1. Try plugging the board in while pressing `L_Ctrl`. This will force it
-   to boot only the bootloader without loading the firmware. Once this is
+1. Try plugging the board in while holding the bootloader key. This will force 
+   it to boot only the bootloader without loading the firmware. Once this is
    done, just reflash the board with the original firmware.
 2. Sometimes USB hubs can act weird, so try connecting the board directly
    to your computer or plugging/unplugging the USB hub.