Use DFU bootloader for rev 3

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

diff --git a/keyboards/ymd96/README.md b/keyboards/ymd96/README.md
index 869dfb1018726e0cfe726258db883a2358d0a00f..9cb37605822d00c2e33b60873bcddc0b8fada320 100644 (file)
--- a/keyboards/ymd96/README.md
+++ b/keyboards/ymd96/README.md
@@ -10,13 +10,15 @@ using Bootmapper Client to change any keyboard settings, since not all the
 USB report options are supported.  
 
 Here is the default layout, it is fairly simple with a few function keys: 
-![YMD96 Layout](https://i.imgur.com/qCwE2ns.png)  
+![YMD96 Layout](https://i.imgur.com/3QnqVPn.png)  
 If you have a different layout (since there were many options during the GB), please feel free to contribute!  
 
 Keyboard maintainer: [Andrew](https://github.com/sparkyman215)  
 Hardware Supported: YMD96 with the ATmega32a chip.  
 Hardware Availability: The GB was run June 2017, [in this thread](https://www.reddit.com/r/mechmarket/comments/6hu3yx/vendor_ymd96_gb_is_now_live_68_an_universal_and/). The vendor has stated that they plan on selling more rounds.
 
+A very big thanks to @krusli for making the RGB underglow, Backlight, CapsLock and NumLock LEDs working correctly.
+
 ## Finding your specific matrix
 
 This firmware was modified from [ps2avrGB](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ps2avrGB), also found on this qmk repo, to work with the YMD96 keyboard. However, I only have one board to test with, which might have a different layout than yours. To get qmk working with your specific layout, you'll need to follow these steps:  
@@ -29,26 +31,23 @@ This firmware was modified from [ps2avrGB](https://github.com/qmk/qmk_firmware/t
 
 ## Installing and Building
 
-First, install the requirements. These commands are for OSX, but all you
-need is the AVR toolchain and `bootloadHID` for flashing:
+Since the YMD96 uses an ATmega32a chip instead of the 32u4, you need to download [HIDBootFlash v.1.0](http://vusb.wikidot.com/project:hidbootflash) for Windows. For Linux you can use the [bootloadHID](https://www.obdev.at/products/vusb/bootloadhid.html) utility (which will require building). Arch Linux users can alternatively install this from the [AUR](https://aur.archlinux.org/packages/bootloadhid/).
+On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linux, you can simply use the terminal. 
 
+Once you have those two pieces of software:
+Build the keyboard by navigating to the root folder of the QMK repo and running
 ```
-$ 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
-the bootloader, you'll need Python 2 with PyUSB installed:
+$ make ymd96:default  
+```  
+If you make your own layout, change the `default` word to whatever your layout is.  
 
+To flash the compiled hex file, simply put the board in flashing mode by plugging it in while holding control. 
+In `HIDBootFlash` first click `find device`, then you can specify the .hex file and flash it to the device. 
+For `bootloadHID`, from a terminal that is in the same folder as your firmware file, run
 ```
-$ pip install pyusb
+$ sudo bootloadHID ymd96_default.hex
 ```
-
-Build the keyboard with  
-```
-$ make ymd96-default  
-```  
-If you make your own layout, change the `default` word to whatever your layout is.  
+Again replacing default with your custom keymap name if required.
 
 ## Troubleshooting
 
@@ -60,3 +59,5 @@ tricks have been useful when it got stuck in a weird scenario.
    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.
+   
+Lastly, if you still need help, you can add me on Discord and I'll be happy to help.