Add a readme.txt file as a brief introduction to this new package.

[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt

The binaries of EdkShellBinPkg are generated with EDK-Shell 1.05 release and build with Edk Compatibility & BaseTools Package\r
(r5439)\r
\r
The following steps can help to re-generate these binaries for customization:\r
1. Check out EdkCompatibilityPkg (r5439) to a directory EdkCompatibilityPkg in workspace (svn https://edk2.tianocore.org/svn/edk2/trunk/edk2/EdkCompatibilityPkg). \r
2. Update to the newest BaseTools package. (r5439 or later)\r
2. Download EfiShell 1.05.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. Apply a hot fix Shell_HotFix.diff under EdkShellBinPkg\GenBin directory. This is mainly to fix the RFC 3066 language comaptiblity issues. This patch will be integrated into the later official release.\r
5. Under workspace directory (i.e. c:\EdkII), execute:\r
   build -a IA32 -a X64 -a IPF -p EdkShellBinPkg\GenBin\EdkShellPkg.dsc\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_MYTOOLS\$(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_MYTOOLS\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.