Merge pull request #220 from DanialPahlavan/master

Update README.md to Improve Clarity and Usability

README.md

@@ -1,73 +1,84 @@
 # Hackintool
 
-The Swiss army knife of vanilla Hackintoshing
+*The Swiss army knife of vanilla Hackintoshing*
 
-## WARNING!
+## ⚠️ Warning
 
-Hackintool is not an automated patching tool that does all the work for you. Knowledge is required on how to patch before using it. Please read the [Intel Framebuffer patching using WhateverGreen](https://www.tonymacx86.com/threads/guide-intel-framebuffer-patching-using-whatevergreen.256490/) guide before you download this tool! I also recommend reading [@jaymonkey](https://www.tonymacx86.com/members/195809/)'s [An iDiot's Guide To Lilu and its Plug-ins](https://www.tonymacx86.com/threads/an-idiots-guide-to-lilu-and-its-plug-ins.260063/) and [@CaseySJ](https://www.tonymacx86.com/members/2134452/)'s [General Framebuffer Patching Guide using Hackintool](https://www.tonymacx86.com/threads/guide-general-framebuffer-patching-guide-hdmi-black-screen-problem.269149).
+Hackintool is not an automated patching tool that does all the work for you. **Knowledge is required** on how to patch before using it. Please read the [Intel Framebuffer patching using WhateverGreen](https://www.tonymacx86.com/threads/guide-intel-framebuffer-patching-using-whatevergreen.256490/) guide before you download this tool! I also recommend reading:
 
-## Mojave, Lilu + WhateverGreen
+- [An iDiot's Guide To Lilu and its Plug-ins by @jaymonkey](https://www.tonymacx86.com/threads/an-idiots-guide-to-lilu-and-its-plug-ins.260063/)
+- [General Framebuffer Patching Guide using Hackintool by @CaseySJ](https://www.tonymacx86.com/threads/guide-general-framebuffer-patching-guide-hdmi-black-screen-problem.269149)
 
-You cannot use the Clover's KextsToPatch for framebuffer patching in Mojave for Skylake and above
+## Mojave, Lilu, and WhateverGreen
+
+Clover's `KextsToPatch` is not usable for framebuffer patching in Mojave for Skylake and newer generations.
 
 ## Framebuffer Dumps
 
-There are a few ways to dump your framebuffer data (the second two require WhateverGreen + Lilu debug versions) to read in Hackintool:
+There are several ways to dump your framebuffer data (the second two require WhateverGreen and Lilu debug versions) to read in Hackintool:
 
-1. Use the Framebuffer->macOS 10.13.6 / Framebuffer->macOS 10.14 menu to create patches without a framebuffer dump
-2. Use the **-igfxdump** boot flag to dump IGPU framebuffer kext to /AppleIntelFramebuffer_X_Y (root of your boot drive) and then File->Open menu
-3. Use the **-igfxfbdump** boot flag to dump native and patched framebuffer table to ioreg and then File->Import->IOReg Dump menu
+1. Use the **Framebuffer -> macOS 10.13.6 / Framebuffer -> macOS 10.14** menu to create patches without a framebuffer dump.
+2. Use the **-igfxdump** boot flag to dump the IGPU framebuffer kext to `/AppleIntelFramebuffer_X_Y` (root of your boot drive) and then use **File -> Open** menu.
+3. Use the **-igfxfbdump** boot flag to dump the native and patched framebuffer table to ioreg and then use **File -> Import -> IOReg Dump** menu.
 
 ## Features
 
-- Supports Sandy Bridge, Ivy Bridge, Haswell, Broadwell, Skylake, Kaby Lake, Coffee Lake, Cannon Lake and Ice Lake generations
-- Create All, Connectors or VRAM patches
+- Supports generations from Sandy Bridge to Ice Lake (Sandy Bridge, Ivy Bridge, Haswell, Broadwell, Skylake, Kaby Lake, Coffee Lake, Cannon Lake, and Ice Lake)
+- Create All, Connectors, or VRAM patches
 - Detect Changes for auto patch creation
-- Create Clover patches in hex, base64 or Devices/Properties formats
+- Create Clover patches in hex, base64, or Devices/Properties formats
 - Displays native GPU and Model identifiers
-- Display and edit Memory Info such as Stolen, Framebuffer, VRAM, Cursor etc.
-- Roll over some items for additional info (Tooltips)
+- Display and edit Memory Info such as Stolen, Framebuffer, VRAM, Cursor, etc.
+- Tooltips for additional info when hovering over some items
 - Reads "live" data directly from Framebuffer kexts (if available; see Mojave note below)
-- File->Open framebuffer file generated by WhateverGreen's -igfxdump boot flag
-- File->Export->Clover config.plist / File->Export->Framebuffer.txt file
-- Patch audio layout id
+- File -> Open framebuffer file generated by WhateverGreen's `-igfxdump` boot flag
+- File -> Export -> Clover config.plist / File -> Export -> Framebuffer.txt file
+- Patch audio layout ID
 - Add USB port limit patch
-- Plug and unplug USB2 / USB3 devices and set port connector types then generate a USBPorts.kext
-- Advanced patching options (DVMT pre-alloc 32 MB, VRAM 2048 MB, Disable eGPU, Enable HDMI20 (4K), DP -> HDMI, GfxYTile Fix, Reboot Fix, USB port Limit, Spoof Audio Device Id, FB Port Limit, Spoof Gfx Device Id)
+- Plug and unplug USB2/USB3 devices and set port connector types, then generate a `USBPorts.kext`
+- Advanced patching options (DVMT pre-alloc 32 MB, VRAM 2048 MB, Disable eGPU, Enable HDMI2.0 (4K), DP -> HDMI, GfxYTile Fix, Reboot Fix, USB port Limit, Spoof Audio Device ID, FB Port Limit, Spoof Gfx Device ID)
+
+
+## Screenshot
+<details>
+  <summary><strong>Click to expand</strong></summary>
+
+  ![Hackintool Screenshot 1](/images/Hackintool01.png)
 
-## Screenshots
+  ![Hackintool Screenshot 2](/images/Hackintool02.png)
 
-![](/images/Hackintool01.png)
+  ![Hackintool Screenshot 3](/images/Hackintool03.png)
 
-![](/images/Hackintool02.png)
+  ![Hackintool Screenshot 4](/images/Hackintool04.png)
 
-![](/images/Hackintool03.png)
+  ![Hackintool Screenshot 5](/images/Hackintool05.png)
 
-![](/images/Hackintool04.png)
+  ![Hackintool Screenshot 6](/images/Hackintool06.png)
 
-![](/images/Hackintool05.png)
+  ![Hackintool Screenshot 7](/images/Hackintool07.png)
 
-![](/images/Hackintool06.png)
+  ![Hackintool Screenshot 8](/images/Hackintool08.png)
 
-![](/images/Hackintool07.png)
+  ![Hackintool Screenshot 9](/images/Hackintool09.png)
 
-![](/images/Hackintool08.png)
+  ![Hackintool Screenshot 10](/images/Hackintool10.png)
 
-![](/images/Hackintool09.png)
+  ![Hackintool Screenshot 11](/images/Hackintool11.png)
 
-![](/images/Hackintool10.png)
+  ![Hackintool Screenshot 12](/images/Hackintool12.png)
 
-![](/images/Hackintool11.png)
+  ![Hackintool Screenshot 13](/images/Hackintool13.png)
 
-![](/images/Hackintool12.png)
+  ![Hackintool Screenshot 14](/images/Hackintool14.png)
 
-![](/images/Hackintool13.png)
+  ![Hackintool Screenshot 15](/images/Hackintool15.png)
 
-![](/images/Hackintool14.png)
+</details>
 
-![](/images/Hackintool15.png)
 
-## Release Notes
+  ## Release Notes
+<details>
+  <summary><strong>Click to expand</strong></summary>
 
 - [Updates are on Github](https://github.com/benbaker76/Hackintool/commits/master)
 - 2.8.6 - Fix crash in getEDIDData, fix Import KextsToPatch
@@ -220,6 +231,7 @@ There are a few ways to dump your framebuffer data (the second two require Whate
 - 1.0.2 - Added Memory tab
 - 1.0.1 - Minor Fixes
 - 1.0.0 - Initial Release
+</details>
 
 ## Credits & Contributions
 
@@ -245,4 +257,6 @@ There are a few ways to dump your framebuffer data (the second two require Whate
 - Model data (everymac.com)
 - Translations: French (Matgen84), German (al6042), Korean (zisqo), Russian / Ukrainian (ctich), Chinese (daliansky, Bat.bat, penghubingzhou)
 - Sparkle framework by Andy Matuschak
-- Icon & UI updates by ultratiem
+- Icon & UI updates by ultratiem
+
+