audk/ShellBinPkg
Jordan Justen fad213a3db EDK II Contributions.txt: Note acceptable contribution licenses
We strongly prefer that contribtions be offered using the same license
as the project/module. But, we should document other acceptable
licenses for contributions.

This will allow package owners to more easily know if they can accept
a contribution under a different source license.

NOTE: This does not modify the wording of the "TianoCore Contribution
      Agreement 1.0" section

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Reviewed-by: Mark Doran <mark.doran@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15892 6f19259b-4bc3-4df7-8a09-765794883524
2014-08-25 23:10:18 +00:00
..
MinUefiShell ShellBinPkg: Updated ARM and AArch64 EFI Shell binaries 2014-05-07 12:58:55 +00:00
UefiShell ShellBinPkg: Updated ARM and AArch64 EFI Shell binaries 2014-05-07 12:58:55 +00:00
Contributions.txt EDK II Contributions.txt: Note acceptable contribution licenses 2014-08-25 23:10:18 +00:00
License.txt
ReadMe.txt
ShellBinPkg.dec

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 (r15493). The binaries are built with no debug information 
by building with "RELEASE" target.

The following steps can help to re-generate these binaries for customization:
1. Check out EDK II to $(WORKSPACE) 
(svn https://svn.code.sf.net/p/edk2/code/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"
   To generate Minimal Shell, execute:
        "build -a IA32 -a X64 -p ShellPkg\ShellPkg.dsc -b RELEASE -D NO_SHELL_PROFILES"

============================================================================
                    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 does not overlap boot manager functionality.
3. Shell documentation is in development and forthcoming.

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