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>
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>

diff --git a/EmulatorPkg/README b/EmulatorPkg/README
deleted file mode 100644 (file)
index fdb26de..0000000
--- a/EmulatorPkg/README
+++ /dev/null
@@ -1,35 +0,0 @@
-\r
-=== EmulatorPkg Overview ===\r
-\r
-EmulatorPkg provides an environment where a UEFI environment can be\r
-emulated under an environment where a full UEFI compatible\r
-environment is not possible.  (For example, running under an OS\r
-where an OS process hosts the UEFI emulation environment.)\r
-\r
-https://github.com/tianocore/tianocore.github.io/wiki/EmulatorPkg\r
-\r
-=== Status ===\r
-\r
-* Builds and runs under a posix-like environment with X windows\r
-  - Linux\r
-  - OS X\r
-\r
-=== Future Plans ===\r
-\r
-* Win32 and Win64 support\r
-\r
-=== Build Scripts ===\r
-\r
-On systems with the bash shell you can use EmulatorPkg/build.sh to simplify\r
-building and running EmulatorPkg.\r
-\r
-For example, to build + run:\r
-$ EmulatorPkg/build.sh\r
-$ EmulatorPkg/build.sh run\r
-\r
-The build architecture will match your host machine's architecture.\r
-\r
-On X64 host machines, you can build + run IA32 mode as well:\r
-$ EmulatorPkg/build.sh -a IA32\r
-$ EmulatorPkg/build.sh -a IA32 run\r
-\r

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