Update the build instructions and change log:

[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt

diff --git a/EdkShellBinPkg/ReadMe.txt b/EdkShellBinPkg/ReadMe.txt
index 9b28fb126eab0335158be2466871e842d035ec47..fb863367f3b7a5e5e7c4f724f8ec37adf09c1760 100644 (file)
--- a/EdkShellBinPkg/ReadMe.txt
+++ b/EdkShellBinPkg/ReadMe.txt
@@ -1,2 +1,17 @@
-This package contains all binary shell applications for IA32, X64 and IPF arch.\r
-They are generated from EfiShell project Official Releases 1.03 of www.tianocore.org. 
\ No newline at end of file
+The binaries of EdkShellBinPkg are generated with EDK-Shell 1.03 release and build with Edk Compatibility Package\r
+(r4226)\r
+\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
+\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