Update default EDK Shell project Folder to be directly under workspace.

[mirror_edk2.git] / EdkShellPkg / ReadMe.txt

diff --git a/EdkShellPkg/ReadMe.txt b/EdkShellPkg/ReadMe.txt
index 55e97fda26577b97905095fabf7f12a3df545f8d..5dfb125bd75a65497f4e7783a936901be1ed3c9d 100644 (file)
--- a/EdkShellPkg/ReadMe.txt
+++ b/EdkShellPkg/ReadMe.txt
@@ -1,12 +1,23 @@
-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.
+This is EDK style package and the following steps can help to build the package:
+1. Download the newly EDK Shell project release EdkShell1.05.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=52&expandFolder=52&folderID=0
+   
+   Alternatively, the EDK Shell source directory can be retrieved from the following SVN address:
+   https://efi-shell.tianocore.org/svn/efi-shell/trunk/Shell 
+   SVN Revision r30 corresponds to EDK Shell 1.05 official release.
+   
+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. Shell.
+

 3. The ShellHotFix.patch file solves the follow two issues in EDK Shell 1.05 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
+   a. RFC3066 language compatibility issue in drivers command.

    b. "CHAR8" compatibility issue in DmpStore, Edit command and shell script execution. 
    b. "CHAR8" compatibility issue in DmpStore, Edit command and shell script execution. 

+   c. Three GUIDs had been retired, PrimaryConsoleInDeviceGuid, PrimaryConsoleOutDeviceGuid and PrimaryStandardErrorDeviceGuid.
+      Reconnect, Edit, HexEdit command are updated.
+   

    This patch will be integrated into the later official release.
    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.
    To use this file, execute the following command under workspace to build EDK Shell source:
 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.
    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
\ No newline at end of file