EmulatorPkg: Add README file

Signed-off-by: jljusten
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11928 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/EmulatorPkg/README b/EmulatorPkg/README
new file mode 100644 (file)
index 0000000..20255b0
--- /dev/null
+++ b/EmulatorPkg/README
@@ -0,0 +1,35 @@
+\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
+http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=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