[PATCH] EmulatorPkg: Update package level Readme.md

[PATCH] EmulatorPkg: Update package level Readme.md

[Ruiyu Ni]

Since the emulator under Windows is enabled, the patch changes
README to include the information of emulator under Windows.
It also changes README to Readme.md for better looking.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Hao A Wu <hao.a.wu@intel.com>
---
 EmulatorPkg/README    | 35 --------------------------
 EmulatorPkg/Readme.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+), 35 deletions(-)
 delete mode 100644 EmulatorPkg/README
 create mode 100644 EmulatorPkg/Readme.md

diff --git a/EmulatorPkg/README b/EmulatorPkg/README
deleted file mode 100644
index fdb26de503..0000000000
--- a/EmulatorPkg/README
+++ /dev/null
@@ -1,35 +0,0 @@
-
-=== EmulatorPkg Overview ===
-
-EmulatorPkg provides an environment where a UEFI environment can be
-emulated under an environment where a full UEFI compatible
-environment is not possible.  (For example, running under an OS
-where an OS process hosts the UEFI emulation environment.)
-
-https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
-
-=== Status ===
-
-* Builds and runs under a posix-like environment with X windows
-  - Linux
-  - OS X
-
-=== Future Plans ===
-
-* Win32 and Win64 support
-
-=== Build Scripts ===
-
-On systems with the bash shell you can use EmulatorPkg/build.sh to simplify
-building and running EmulatorPkg.
-
-For example, to build + run:
-$ EmulatorPkg/build.sh
-$ EmulatorPkg/build.sh run
-
-The build architecture will match your host machine's architecture.
-
-On X64 host machines, you can build + run IA32 mode as well:
-$ EmulatorPkg/build.sh -a IA32
-$ EmulatorPkg/build.sh -a IA32 run
-
diff --git a/EmulatorPkg/Readme.md b/EmulatorPkg/Readme.md
new file mode 100644
index 0000000000..461975e859
--- /dev/null
+++ b/EmulatorPkg/Readme.md
@@ -0,0 +1,68 @@
+## Overview
+
+EmulatorPkg provides an environment where a UEFI environment can be
+emulated under an environment where a full UEFI compatible
+environment is not possible.  (For example, running under an OS
+where an OS process hosts the UEFI emulation environment.)
+
+https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
+
+## Status
+
+* Builds and runs under
+  *  a posix-like environment with X windows
+      - Linux
+      - OS X
+  *  Windows environment
+      - Win10 (verified)
+      - Win8 (not verified)
+
+## How to Build & Run
+**You can use the following command to build.**
+  * 32bit emulator in Windows:
+
+    `build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -D WIN_SEC_BUILD -a IA32`
+
+  * 64bit emulator in Windows:
+
+    `build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -D WIN_SEC_BUILD -a X64`
+
+  * 32bit emulator in Linux:
+
+    `build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -D UNIX_SEC_BUILD -a IA32`
+
+  * 64bit emulator in Linux:
+
+    `build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -D UNIX_SEC_BUILD -a X64`
+
+**You can start/run the emulator using the following command:**
+  * 32bit emulator in Windows:
+
+    `cd Build\EmulatorIA32\DEBUG_VS2017\IA32\ && WinHost.exe`
+
+  * 64bit emulator in Windows:
+
+    `cd Build\EmulatorX64\DEBUG_VS2017\X64\ && WinHost.exe`
+
+  * 32bit emulator in Linux:
+
+    `cd Build/EmulatorIA32/DEBUG_GCC5/IA32/ && ./Host`
+
+  * 64bit emulator in Linux:
+
+    `cd Build/EmulatorX64/DEBUG_GCC5/X64/ && ./Host`
+
+**On posix-like environment with the bash shell you can use EmulatorPkg/build.sh to simplify building and running
+emulator.**
+
+For example, to build + run:
+
+`$ EmulatorPkg/build.sh`  
+`$ EmulatorPkg/build.sh run`
+
+The build architecture will match your host machine's architecture.
+
+On X64 host machines, you can build + run IA32 mode as well:
+
+`$ EmulatorPkg/build.sh -a IA32`  
+`$ EmulatorPkg/build.sh -a IA32 run`
-- 
2.16.1.windows.1

Re: [PATCH] EmulatorPkg: Update package level Readme.md

[Wu, Hao A]

Reviewed-by: Hao Wu <hao.a.wu@intel.com>

Best Regards,
Hao Wu


> -----Original Message-----
> From: Ni, Ruiyu
> Sent: Tuesday, September 04, 2018 9:19 AM
> To: edk2-devel@lists.01.org
> Cc: Kinney, Michael D; Wu, Hao A
> Subject: [PATCH] EmulatorPkg: Update package level Readme.md
> 
> Since the emulator under Windows is enabled, the patch changes
> README to include the information of emulator under Windows.
> It also changes README to Readme.md for better looking.
> 
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Hao A Wu <hao.a.wu@intel.com>
> ---
>  EmulatorPkg/README    | 35 --------------------------
>  EmulatorPkg/Readme.md | 68
> +++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 68 insertions(+), 35 deletions(-)
>  delete mode 100644 EmulatorPkg/README
>  create mode 100644 EmulatorPkg/Readme.md
> 
> diff --git a/EmulatorPkg/README b/EmulatorPkg/README
> deleted file mode 100644
> index fdb26de503..0000000000
> --- a/EmulatorPkg/README
> +++ /dev/null
> @@ -1,35 +0,0 @@
> -
> -=== EmulatorPkg Overview ===
> -
> -EmulatorPkg provides an environment where a UEFI environment can be
> -emulated under an environment where a full UEFI compatible
> -environment is not possible.  (For example, running under an OS
> -where an OS process hosts the UEFI emulation environment.)
> -
> -https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
> -
> -=== Status ===
> -
> -* Builds and runs under a posix-like environment with X windows
> -  - Linux
> -  - OS X
> -
> -=== Future Plans ===
> -
> -* Win32 and Win64 support
> -
> -=== Build Scripts ===
> -
> -On systems with the bash shell you can use EmulatorPkg/build.sh to simplify
> -building and running EmulatorPkg.
> -
> -For example, to build + run:
> -$ EmulatorPkg/build.sh
> -$ EmulatorPkg/build.sh run
> -
> -The build architecture will match your host machine's architecture.
> -
> -On X64 host machines, you can build + run IA32 mode as well:
> -$ EmulatorPkg/build.sh -a IA32
> -$ EmulatorPkg/build.sh -a IA32 run
> -
> diff --git a/EmulatorPkg/Readme.md b/EmulatorPkg/Readme.md
> new file mode 100644
> index 0000000000..461975e859
> --- /dev/null
> +++ b/EmulatorPkg/Readme.md
> @@ -0,0 +1,68 @@
> +## Overview
> +
> +EmulatorPkg provides an environment where a UEFI environment can be
> +emulated under an environment where a full UEFI compatible
> +environment is not possible.  (For example, running under an OS
> +where an OS process hosts the UEFI emulation environment.)
> +
> +https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg
> +
> +## Status
> +
> +* Builds and runs under
> +  *  a posix-like environment with X windows
> +      - Linux
> +      - OS X
> +  *  Windows environment
> +      - Win10 (verified)
> +      - Win8 (not verified)
> +
> +## How to Build & Run
> +**You can use the following command to build.**
> +  * 32bit emulator in Windows:
> +
> +    `build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -D WIN_SEC_BUILD -a
> IA32`
> +
> +  * 64bit emulator in Windows:
> +
> +    `build -p EmulatorPkg\EmulatorPkg.dsc -t VS2017 -D WIN_SEC_BUILD -a
> X64`
> +
> +  * 32bit emulator in Linux:
> +
> +    `build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -D UNIX_SEC_BUILD -a
> IA32`
> +
> +  * 64bit emulator in Linux:
> +
> +    `build -p EmulatorPkg\EmulatorPkg.dsc -t GCC5 -D UNIX_SEC_BUILD -a X64`
> +
> +**You can start/run the emulator using the following command:**
> +  * 32bit emulator in Windows:
> +
> +    `cd Build\EmulatorIA32\DEBUG_VS2017\IA32\ && WinHost.exe`
> +
> +  * 64bit emulator in Windows:
> +
> +    `cd Build\EmulatorX64\DEBUG_VS2017\X64\ && WinHost.exe`
> +
> +  * 32bit emulator in Linux:
> +
> +    `cd Build/EmulatorIA32/DEBUG_GCC5/IA32/ && ./Host`
> +
> +  * 64bit emulator in Linux:
> +
> +    `cd Build/EmulatorX64/DEBUG_GCC5/X64/ && ./Host`
> +
> +**On posix-like environment with the bash shell you can use
> EmulatorPkg/build.sh to simplify building and running
> +emulator.**
> +
> +For example, to build + run:
> +
> +`$ EmulatorPkg/build.sh`
> +`$ EmulatorPkg/build.sh run`
> +
> +The build architecture will match your host machine's architecture.
> +
> +On X64 host machines, you can build + run IA32 mode as well:
> +
> +`$ EmulatorPkg/build.sh -a IA32`
> +`$ EmulatorPkg/build.sh -a IA32 run`
> --
> 2.16.1.windows.1