BaseTools/Capsule: Do not support -o with --dump-info

[mirror_edk2.git] / EdkShellPkg / ReadMe.txt

diff --git a/EdkShellPkg/ReadMe.txt b/EdkShellPkg/ReadMe.txt
index f36eb3dc43d16691b345f2abaa98d2c8b389ea98..b6ce6f5aab3cb7d4946175ff9df45eeaa8343c70 100644 (file)
--- a/EdkShellPkg/ReadMe.txt
+++ b/EdkShellPkg/ReadMe.txt
@@ -1,12 +1,25 @@
-This is EDK style package:
-1. It contians an SVN extern Shell directory for the SVN address:
-   https://efi-shell.tianocore.org/svn/efi-shell/trunk/Shell
-2. This SVN extern directory is from EDK Shell Source project and is read only.
-   Currently version (r30) corresponds to EDK Shell 1.05 official release.
-3. The ShellHotFix.patch file solves the follow two issues in EDK Shell 1.05 release:
-   a. RFC3066 language compatibility issue in drivers command
-   b. "CHAR8" compatibility issue in DmpStore command. 
-   This patch will be integrated into the later official release.
-4. The EDK II style DSC file is used to validate build EDK Shell source & EDK compatibility package and can generate the binaries in EdkShellBinPkg.
+This is EDK style package and the following steps can help to build the package:
+1. Download the newly EDK Shell project Efi-Shell-Dev-Snapshot-20090527.zip from the following URL and unzip it to
+   a local directory in workspace, for example, $(WORKSPACE)\Shell: 
+   https://efi-shell.tianocore.org/servlets/ProjectDocumentList?folderID=46&expandFolder=46&folderID=53
+   
+   Alternatively, the EDK Shell source directory can be retrieved from the following SVN address:
+   https://svn.code.sf.net/p/efi-shell/code/trunk/Shell
+   SVN Revision r33 corresponds to Efi-Shell-Dev-Snapshot-20090527.zip development snapshot.
+   
+2. Update EDK_SHELL_DIR macro in the [Defines] section in EdkShellPkg.dsc to point to
+   the directory containing the EDK Shell source directory, e.g. $(WORKSPACE)\Shell.
+
+3. The EDK II style DSC file is used to validate build EDK Shell source & EDK compatibility package and can
+   generate the binaries in EdkShellBinPkg.
    To use this file, execute the following command under workspace to build EDK Shell source:
-   build -a IA32 -a X64 -a IPF EdkShellPkg\EdkShellPkg.dsc
\ No newline at end of file
+   build -a IA32 -a X64 -a IPF -p EdkShellPkg\EdkShellPkg.dsc
+   
+4. If you need to compile for GCC or ARM you will need to apply ShellR64.patch.
+   cd $(WORKSPACE)/Shell and execute patch -p0 < $(WORKSPACE)/EdkShellPkg/ShellR64.patch.
+   If you are using a case sensative file system there are a few case bugs that patch 
+   would not fix. Just fix the case of the file to match its usage and you should be 
+   able to compile.
+   
+5. If you need to use the binaries that are built from this package, be sure to update platform FDF file
+    to replace the binaries from EdkShellBinPkg.