update the function header comment to comply with PI1.2 volume 5
[edk2.git] / EdkShellPkg / ReadMe.txt
blob78607c10373b2c1bda4633af3217cad601b1c302
1 This is EDK style package and the following steps can help to build the package:
2 1. Download the newly EDK Shell project Efi-Shell-Dev-Snapshot-20090527.zip from the following URL and unzip it to
3    a local directory in workspace, for example, $(WORKSPACE)\Shell: 
4    https://efi-shell.tianocore.org/servlets/ProjectDocumentList?folderID=46&expandFolder=46&folderID=53
5    
6    Alternatively, the EDK Shell source directory can be retrieved from the following SVN address:
7    https://efi-shell.tianocore.org/svn/efi-shell/trunk/Shell 
8    SVN Revision r33 corresponds to Efi-Shell-Dev-Snapshot-20090527.zip development snapshot.
9    
10 2. Update EDK_SHELL_DIR macro in the [Defines] section in EdkShellPkg.dsc to point to
11    the directory containing the EDK Shell source directory, e.g. $(WORKSPACE)\Shell.
13 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.
14    To use this file, execute the following command under workspace to build EDK Shell source:
15    build -a IA32 -a X64 -a IPF -p EdkShellPkg\EdkShellPkg.dsc