simple readme fix

[qmk_firmware.git] / keyboards / singa / readme.md

diff --git a/keyboards/singa/readme.md b/keyboards/singa/readme.md
index c0325d1a02783814cffcd43aba707e8eb5937666..faeb816ec11735893f8a7ab49d0fe9e878d9b109 100644 (file)
--- a/keyboards/singa/readme.md
+++ b/keyboards/singa/readme.md
@@ -4,11 +4,11 @@
 ![Singa](https://i.imgur.com/VVO27Tr.jpg)
 
 
-A short description of the keyboard/project
+75% Custom Keyboard. 
 
 
-Keyboard Maintainer: [amnesia0287](https://github.com/amnesia0287)
-Hardware Supported: TGR-Elaine v1.0 PCB
+Keyboard Maintainer: [amnesia0287](https://github.com/amnesia0287)  
+Hardware Supported: TGR-Elaine v1.0 PCB  
 Hardware Availability: http://singakbd.com/
 
 
@@ -16,4 +16,37 @@ Make example for this keyboard (after setting up your build environment):
 
     make singa:default
 
-See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+Flashing
+
+ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
+
+**Reset Key:** Hold down the key located at `K00`, commonly programmed as `Esc` while plugging in the keyboard.  
+
+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).