Update the build instructions and change log:
[mirror_edk2.git] / EdkShellBinPkg / ReadMe.txt
index 5b8c967d56794bab8dc2f89d879a2f02641cc90b..fb863367f3b7a5e5e7c4f724f8ec37adf09c1760 100644 (file)
@@ -1,20 +1,17 @@
-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.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