Fix several typos for the instructions to build shell binaries with ECP & EDK II...

[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt

diff --git a/EdkShellBinPkg/ReadMe.txt b/EdkShellBinPkg/ReadMe.txt
index fb863367f3b7a5e5e7c4f724f8ec37adf09c1760..056126fcb888441647f8910f8f4915de8cb5cc77 100644 (file)
--- a/EdkShellBinPkg/ReadMe.txt
+++ b/EdkShellBinPkg/ReadMe.txt
@@ -1,17 +1,35 @@
-The binaries of EdkShellBinPkg are generated with EDK-Shell 1.03 release and build with Edk Compatibility Package\r
-(r4226)\r
+The binaries of EdkShellBinPkg are generated with EDK-Shell 1.04 release and build with Edk Compatibility & BaseTools Package\r
+(r4631)\r
 \r
+The following steps can help to re-generate these binaries for customization:\r
+1. Check out EdkCompatibilityPkg (r4631) to a directory EdkCompatibilityPkg in workspace (svn https://edk2.tianocore.org/svn/edk2/trunk/edk2/EdkCompatibilityPkg). \r
+2. Update to the newest BaseTools package.\r
+2. Download EfiShell 1.04.zip from EDK Shell official release https://efi-shell.tianocore.org/servlets/ProjectDocumentList?folderID=52&expandFolder=52&folderID=45\r
+3. Unzip it to be a sub-directory in EdkCompatibilityPkg , i.e. c:\EdkII\EdkCompatibilityPkg\Shell\r
+4. Work around an issue in EdkCompatibilityPkg\Shell\ver\Ver.inf to split:\r
+  [sources.ia32|x64]\r
+    ia32\ver32.c\r
 \r
-The following steps are can help to re-generate these binaries for customization:\r
-1. Check out EdkCompatibilityPkg (r4226) to a directory EdkCompatibilityPkg in workspace (svn https://edk2.tianocore.org/svn/edk2/trunk/edk2/EdkCompatibilityPkg). \r
-2. Download EfiShell 1.03.zip from EDK Shell official release https://efi-shell.tianocore.org/servlets/ProjectDocumentList?folderID=52&expandFolder=52&folderID=45\r
-3. Unzip it to a local folder in EdkCompatibilityPkg , e.g. c:\EdkII\EdkCompatibilityPkg\Other\Maintained\Application\Shell\r
-4. Add the INF file under [components] section of platform DSC files:\r
-  EdkCompatibilityPkg\Sample\Platform\Ia32\Build\Ia32.dsc\r
-  EdkCompatibilityPkg\Sample\Platform\X64\Build\X64.dsc\r
-  EdkCompatibilityPkg\Sample\Platform\Ipf\Build\Ipf.dsc\r
-4.Set environment variable of EDK_SOURCE, e.g. EDK_SOURCE=c:\EdkII\EdkCompatibilityPkg\r
-5.Go to build directory of different architecture and enter "build", e.g. EdkCompatibilityPkg\Sample\Platform\Ia32\Build \r
+  to be:\r
+  [sources.ia32]\r
+    ia32\ver32.c\r
+\r
+  [sources.x64]\r
+    ia32\ver32.c\r
+\r
+   since current build tools (r4631) do not support this syntax in EDK INF format.\r
+\r
+5. Under workspace directory (i.e. c:\EdkII), execute:\r
+   build -a IA32 -a X64 -a IPF -p EdkShellBinPkg\GenBin\EdkShellPkg.dsc -t WINDDK3790x1830\r
+   The use of WINDDK instead of MYTOOLS is due to the fact that EDK shell source 1.04 is not\r
+   VS2005 clean.\r
+\r
+6. Copy the binaries from Build directory to this package. Typically the EFI binary\r
+   of EdkCompatibility\Shell\$(INF_BASENAME).inf is generated at:\r
+   Build\EdkShellPkg\DEBUG_WINDDK3790x1830\$(ARCH)\EdkCompatibility\Shell\$(INF_BASENAME)\OUTPUT\$(BASENAME).efi\r
+   For example:\r
+   The x64 EFI image of EdkCompatibility\Shell\ver\ver.inf is generated at:\r
+   Build\EdkShellPkg\DEBUG_WINDDK3790x1830\X64\EdkCompatibilityPkg\Shell\ver\Ver\OUTPUT\ver.efi\r
 \r
 Note: Other\Maintained\Application\Shell\Shell.inf corresponds to Minimum shell binaries.\r
       Other\Maintained\Application\Shell\ShellFull.inf corresponds to Full Shell binaries.
\ No newline at end of file