update file header

[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt

diff --git a/EdkShellBinPkg/ReadMe.txt b/EdkShellBinPkg/ReadMe.txt
index 5b8c967d56794bab8dc2f89d879a2f02641cc90b..adcd8cef5c61c284dfd568c60d99eb04d2abdfe5 100644 (file)
--- a/EdkShellBinPkg/ReadMe.txt
+++ b/EdkShellBinPkg/ReadMe.txt
@@ -1,20 +1,21 @@
-The binaries of EdkShellBinPkg are directly retrieved from EDK 1.03 release with the following steps:\r
-1.Download Edk1.03.zip from EDK official release site: ://edk.tianocore.org/servlets/ProjectDocumentList?folderID=6&expandFolder=6&folderID=0\r
-2.Unzip it to a local folder, e.g. c:\Edk.\r
-3.The EDK II prime binaries are mapped as follows:\r
-EDKII prime                                        Edk\\r
-EdkShellBinPkg\FullShell\ia32\Shell_Full.efi       Other\Maintained\Application\UefiShell\bin\ia32\Shell_Full.efi      \r
-EdkShellBinPkg\FullShell\x64\Shell_Full.efi        Other\Maintained\Application\UefiShell\bin\x64\Shell_Full.efi       \r
-EdkShellBinPkg\FullShell\ipf\Shell_Full.efi        Other\Maintained\Application\UefiShell\bin\ipf\Shell_Full.efi       \r
-EdkShellBinPkg\MinimumShell\ia32\Shell.efi         Other\Maintained\Application\UefiShell\bin\ipf\Shell.efi    \r
-EdkShellBinPkg\MinimumShell\x64\Shell.efi          Other\Maintained\Application\UefiShell\bin\x64\Shell.efi\r
-EdkShellBinPkg\MinimumShell\ipf\Shell.efi          Other\Maintained\Application\UefiShell\bin\ipf\Shell.efi\r
-EdkShellBinPkg\bin\ia32\Shell_Full.efi             Other\Maintained\Application\UefiShell\bin\ia32\Shell_Full.efi      \r
-EdkShellBinPkg\bin\x64\Shell_Full.efi              Other\Maintained\Application\UefiShell\bin\x64\Shell_Full.efi       \r
-EdkShellBinPkg\bin\ipf\Shell_Full.efi              Other\Maintained\Application\UefiShell\bin\ipf\Shell_Full.efi       \r
-EdkShellBinPkg\bin\ia32\Shell.efi                  Other\Maintained\Application\UefiShell\bin\ipf\Shell.efi    \r
-EdkShellBinPkg\bin\x64\Shell.efi                   Other\Maintained\Application\UefiShell\bin\x64\Shell.efi\r
-EdkShellBinPkg\bin\ipf\Shell.efi                   Other\Maintained\Application\UefiShell\bin\ipf\Shell.efi\r
-EdkShellBinPkg\bin\ia32\Apps\*                     Other\Maintained\Application\UefiShell\bin\ia32\Apps\*\r
-EdkShellBinPkg\bin\x64\Apps\*                      Other\Maintained\Application\UefiShell\bin\x64\Apps\*\r
-EdkShellBinPkg\bin\ipf\Apps\*                      Other\Maintained\Application\UefiShell\bin\ipf\Apps\*\r
+The binaries of EdkShellBinPkg are generated with EDK-Shell 1.05 release and build with Edk Compatibility & BaseTools Package\r
+(r5782)\r
+\r
+The following steps can help to re-generate these binaries for customization:\r
+1. Check out EdkCompatibilityPkg (r5782) to $(WORKSPACE)\EdkCompatibilityPkg (svn https://edk2.tianocore.org/svn/edk2/trunk/edk2/EdkCompatibilityPkg).\r
+2. Check out EdkShellPkg(r5782) to $(WORKSPACE)\EdkShellPkg (svn https://efi-shell.tianocore.org/servlets/ProjectDocumentList?folderID=52&expandFolder=52&folderID=45).\r
+   This package has an SVN extern directory from EDK Shell project. It is read-only and current revison (r30) is identical to EDK shell 1.05 release. \r
+3. Update to the newest BaseTools package. (r5782 or later)\r
+4. Apply a hot fix ShellHotFix.patch under EdkShellPkg directory.\r
+   Add a Shell Hot Fix patch to solve RFC3066 language compatibility issue and "CHAR8" compatibility issue in DmpStore, Edit command and shell script execution.\r
+   This patch will be integrated into the later official release.\r
+5. Under workspace directory (i.e. c:\EdkII), execute: build -a IA32 -a X64 -a IPF -p EdkShellPkg\EdkShellPkg.dsc\r
+6. Copy the binaries from Build directory to this package. Typically the EFI binary\r
+   of EdkShellPkg\Shell\$(INF_BASENAME).inf is generated at:\r
+   Build\EdkShellPkg\DEBUG_MYTOOLS\$(ARCH)\EdkShellPkg\Shell\$(INF_BASENAME)\OUTPUT\$(BASENAME).efi\r
+   For example:\r
+   The x64 EFI image of EdkShellPkg\Shell\ver\ver.inf is generated at:\r
+   Build\EdkShellPkg\DEBUG_MYTOOLS\X64\EdkShellPkg\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