audk/ShellBinPkg
mdkinney abc6ae04db Clean up DEC files:
1) Remove section header comment blocks that do not provide any information
2) Combine PCDs listed in multiple sections into a single section that supports multiple PCD types to reduce maintenance overhead
3) Remove ModuleTypeList comments from [Includes], [Protocols], [Ppis], and [Guids] sections that do not properly describe the module type restrictions.
4) Clean up formatting of GUID structure declarations
5) Remove ".common" from section names if they are not required.
6) Order sections consistently as [Defines], [Includes], [LibraryClasses], [Guid], [Ppis], [Protocols], [PcdsFeatureFlag], [PcdsFixedAtBuild], [PcdsPatchableInModule], [PcdsDynamic], and [PcdsDynamicEx]


git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11636 6f19259b-4bc3-4df7-8a09-765794883524
2011-05-09 17:51:36 +00:00
..
UefiShell Updating ShellBinPkg to include revision information in readme file. 2011-04-27 16:56:27 +00:00
ReadMe.txt fix too long lines. 2011-04-28 01:39:31 +00:00
ShellBinPkg.dec Clean up DEC files: 2011-05-09 17:51:36 +00:00

ReadMe.txt

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

============================================================================
                                 OVERVIEW
============================================================================
The binaries of ShellBinPkg are generated with ShellPkg project and built with
BaseTools Package. The binaries are built with no debug information by building
with "RELEASE" target. The EDKII revision 11595 was used for both.

The following steps can help to re-generate these binaries for customization:
1. Check out EDK II to $(WORKSPACE) 
   (svn https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2).
2. Under $(WORKSPACE) directory (i.e. c:\EdkII),
   To generate Shell, execute: 
      "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE".

============================================================================
                    HOW TO INCORPORATE THIS SHELL INTO NT32
============================================================================
The instructions below are included as a sample and template on how a 
developer may integrate this code into an existing platform:

1. Update system PCDs to support this new module
   Update the PCD as follows using the Shell's PCD:
   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, 
    0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 
    0xB4, 0xD1 }

2. Remove the old shell from the NT32 Firmware list
   Remove the FILE APPLICATION section for the old shell.

3. Add this shell to the NT32 firmware list
   Add the Shell.INF to the end of the list of DXE modules.

4. Build NT32

============================================================================
                          KNOWN LIMITATIONS
============================================================================
1. RM can delete current working directory via other map name.
2. DrvCfg is not functional.
3. ifConfig permanent settings are under investigation (may not function correctly)
4. Shell documentation is in development and forthcoming.

============================================================================