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