Regenerate the related EDK Shell binaries after fixing a bug in Pci.c to add missing...

[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt

diff --git a/EdkShellBinPkg/ReadMe.txt b/EdkShellBinPkg/ReadMe.txt
index fb863367f3b7a5e5e7c4f724f8ec37adf09c1760..5a08f55d769dd00c8d122b0f1f85a397a37ffc42 100644 (file)
--- a/EdkShellBinPkg/ReadMe.txt
+++ b/EdkShellBinPkg/ReadMe.txt
@@ -1,17 +1,12 @@
-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 EFI shell project (svn r54) and build with Edk Compatibility & BaseTools Package (r10348). The binaries are built with no debug information by building with "RELEASE" target.\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
+The following steps can help to re-generate these binaries for customization:\r
+1. Check out EdkCompatibilityPkg (r10348) to $(WORKSPACE)\EdkCompatibilityPkg (svn https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2/EdkCompatibilityPkg).\r
+2. Check out EdkShellPkg(r10348) to $(WORKSPACE)\EdkShellPkg (svn https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2/EdkShellPkg).\r
+3. Check out Edk Shell project source (r54) to $(WORKSPACE)\Shell (svn https://efi-shell.svn.sourceforge.net/svnroot/efi-shell/trunk/Shell). \r
+4. Update to the newest BaseTools package (r10348) to $(WORKSPACE)\BaseTools (svn https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2/BaseTools).\r
+5. Under $(WORKSPACE) directory (i.e. c:\EdkII),\r
+   To generate Minimum Shell, execute: "build -a IA32 -a X64 -a IPF -p EdkShellPkg\EdkShellPkg.dsc -m Shell\Shell.inf -b RELEASE".\r
+   To generate Full Shell, execute: "build -a IA32 -a X64 -a IPF -p EdkShellPkg\EdkShellPkg.dsc -m Shell\ShellFull.inf -b RELEASE".\r
+6. In EdkShellBinPkg\Bin, we only provides the binary files of those applications which haven't been contained in Minmum Shell but in Full Shell.\r
+   To generate them, execute: "build -a IA32 -a X64 -a IPF -p EdkShellPkg\EdkShellPkg.dsc -m Shell\Xxx\Xxx.inf -b RELEASE". Xxx means the corresponding module name.\r