Contributed-under: TianoCore Contribution Agreement 1.1

Signed-off-by: Guo Mang <mang.guo@intel.com>
---
 ReadMe.MD | 63 ++++++++++++++++++++++++++++++++++++---------------------------
 1 file changed, 36 insertions(+), 27 deletions(-)

diff --git a/ReadMe.MD b/ReadMe.MD
index f5cbc7c..a42260e 100644
--- a/ReadMe.MD
+++ b/ReadMe.MD
@@ -41,17 +41,19 @@ This code base is based on UDK2017 core packages.
       Download PREBOOT.EXE Version 21.1 from the "Intel® Ethernet Connections
       Boot Utility, Preboot Images, and EFI Drivers" page.
       https://downloadcenter.intel.com/download/19186/Intel-Ethernet-Connections-Boot-Utility-Preboot-Images-and-EFI-Drivers
-   Windows user:
-   1. Install PREBOOT.EXE into the default folder (C:\Intel21.1).
-   2. Copy the UEFI x64 PCI-E gigabit driver (C:\Intel21.1\APPS\EFI\EFIx64\E7320X3.EFI) 
+
+      Windows user:
+      1. Install PREBOOT.EXE into the default folder (C:\Intel21.1).
+      2. Copy the UEFI x64 PCI-E gigabit driver (C:\Intel21.1\APPS\EFI\EFIx64\E7320X3.EFI) 
       to the platform package directory below, create the folder if it does not exist:
-      "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Binaries\UNDI\I210PcieUndiDxe"
-   Linux user:
-   1. Use command "unzip PREBOOT.EXE" to extract UEFI x64 PCI-E gigabit driver
+        * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Binaries\UNDI\I210PcieUndiDxe"
+
+      Linux user:
+      1. Use command "unzip PREBOOT.EXE" to extract UEFI x64 PCI-E gigabit driver
       (preboot/APPS/EFI/EFIx64/E7320X3.EFI)
-   2. Copy E7320X3.EFI to platform package directory below, create the folder
+      2. Copy E7320X3.EFI to platform package directory below, create the folder
       if it does not exist:
-    * "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Binaries/UNDI/I210PcieUndiDxe"
+        * "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Binaries/UNDI/I210PcieUndiDxe"
 
 6. Follow the instructions found in the "Patch-HOWTO.txt" file located in the Workspace
    (e.g. "C:\MyWorkspace\edk2-platforms\Core\CryptoPkg\Library\OpensslLib\Patch-HOWTO.txt")
@@ -67,7 +69,7 @@ This code base is based on UDK2017 core packages.
 ## 2. HOW TO BUILD (WINDOWS ENVIRONMENT)
 
 Windows System Configuration:
-  Microsoft Windows 7 Ultimate 64-bit*
+  - Microsoft Windows 7 Ultimate 64-bit*
 
 1. Setup Build Environment
 
@@ -77,24 +79,29 @@ Windows System Configuration:
       * Make sure that a file with the extension of ".py" will be opened by Python.exe.
 
    3. Install the NASM assembly language compiler:
-      a. Download NASM 2.12.02 binaries:
+
+        a. Download NASM 2.12.02 binaries:
         * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win32/nasm-2.12.02-win32.zip
         * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win64/nasm-2.12.02-win64.zip
-      b. Unzip the 32-bit & 64-bit versions of nasm.exe to the directories listed below,
+
+        b. Unzip the 32-bit & 64-bit versions of nasm.exe to the directories listed below,
          respectively, and create the folders if they do not exist:
         * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win32"
         * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\nasm\Win64"
 
    4. Install the ACPI Source Language (ASL) compiler:
-      a. Install the IASL 2016-09-30 compiler from acpica.org:
+
+        a. Install the IASL 2016-09-30 compiler from acpica.org:
          https://acpica.org/sites/acpica/files/iasl-win-20160930.zip
-      b. Unzip the "iasl.exe" file into the directory below, and create the folder
+
+        b. Unzip the "iasl.exe" file into the directory below, and create the folder
          if it does not exist:
          * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Iasl"
 
 2. Build
 
-  2a. Build Steps (32-bit)
+    2a. Build Steps (32-bit)
+
     1. To build a 32-bit release version
       * Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";
       * Type the command: `cd C:\MyWorkspace\edk2-platforms`
@@ -110,9 +117,10 @@ Windows System Configuration:
     3. After the build successfully completes, the 8MB firmware binary image will be located in the
        following location on your local hard drive:
 
-      "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Stitch"
+      * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Stitch"
+
+    2b. Build Steps (64-bit)
 
-  2b. Build Steps (64-bit)
     1. To build a 64-bit release version
       * Open a command prompt of Microsoft Visual Studio, such as "Developer Command Prompt for VS2013";
       * Type the command: `cd C:\MyWorkspace\edk2-platforms`
@@ -128,36 +136,37 @@ Windows System Configuration:
     3. After the build successfully completes, the 8MB firmware binary image will be located in the
       following location on your local hard drive:
 
-      "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Stitch"
+     * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Tools\Stitch"
 
 ## 3. HOW TO BUILD (LINUX ENVIRONMENT)
 
 Linux System Configuration:
-  Ubuntu 16.04 64-bit
-  bash shell
-  gcc version 5 or above
+  - Ubuntu 16.04 64-bit
+  - bash shell
+  - gcc version 5 or above
 
 1. Setup Build Environment
-   Use below command to install required packages:
+      Use below command to install required packages:
+      ```
       # sudo apt-get update
       # sudo apt-get install nasm
       # sudo apt-get install iasl
       # sudo apt-get install build-essential
       # sudo apt-get install uuid-dev
-
+      ```
 2. Build Steps (64-bit)
     1. To build a 64-bit release version
-      * Open a command prompt, type command: "cd ~/src/MyWorkspace/edk2-platforms";
-      * For MinnowBoard 3 FAB B, type the command:"./BuildBIOS.sh /B Release" to build a release version.
+      * Open a command prompt, type command: `cd ~/src/MyWorkspace/edk2-platforms`;
+      * For MinnowBoard 3 FAB B, type the command:`./BuildBIOS.sh /B Release` to build a release version.
         (Replace "/B" with "/A" for MinnowBoard 3 FAB A board)
     2. To build a 64-bit debug version 
-      * Open a command prompt, type command: "cd ~/src/MyWorkspace/edk2-platforms";
-      * For MinnowBoard 3 FAB B, type the command:"./BuildBIOS.sh /B Debug" to build a debug version.
+      * Open a command prompt, type command: `cd ~/src/MyWorkspace/edk2-platforms`;
+      * For MinnowBoard 3 FAB B, type the command:`./BuildBIOS.sh /B Debug` to build a debug version.
         (Replace "/B" with "/A" for MinnowBoard 3 FAB A board)
     3. After the build successfully completes, the 8MB firmware binary image will be located in the
        following location on your local hard drive:
 
-      "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Tools/Stitch/"
+     * "~/src/MyWorkspace/edk2-platforms/Platform/BroxtonPlatformPkg/Common/Tools/Stitch/"
 
 ## MAINTAINERS
 
-- 
2.10.1.windows.1

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel