diff options
| author | jljusten <jljusten@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-06-29 16:30:51 +0000 |
|---|---|---|
| committer | jljusten <jljusten@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-06-29 16:30:51 +0000 |
| commit | 82b2ab64f1b90a3ed70c344d410df4b4a9975013 (patch) | |
| tree | ed96ab7a173ebc6492653264bbf55229043b112f | |
| parent | 461e8e8e148171a30d9872f23ab5410897c5ff8f (diff) | |
| download | edk2-platforms-82b2ab64f1b90a3ed70c344d410df4b4a9975013.tar.xz | |
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
| -rw-r--r-- | EmulatorPkg/README | 35 |
1 files changed, 35 insertions, 0 deletions
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
+
|