Comment's added and fixed.
[mirror_edk2.git] / ShellPkg / Readme.txt
1 ============================================================================\r
2                                  OVERVIEW\r
3 ============================================================================\r
4 The UEFI 2.0 shell provides a standard pre-boot command line processor.\r
5 It is similar to the EDK EFI Shell or a *nix command line parser.\r
6 \r
7 ============================================================================\r
8                     HOW TO INCORPORATE THIS SHELL INTO NT32\r
9 ============================================================================\r
10 The instructions below are included as a sample and template on how a \r
11 developer may integrate this code into an existing platform:\r
12 \r
13 1. Add this shell build to the NT32 build:\r
14    Add the shell.inf to the [components] section as it is in the ShellPkg.dsc.\r
15 \r
16 2. Update system PCDs to support this new module\r
17    Update the PCD as follows using the Shell's PCD:\r
18    gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1 }\r
19 \r
20 3. Remove the old shell from the NT32 Firmware list\r
21    Remove the FILE APPLICATION section for the old shell.\r
22 \r
23 4. Add this shell to the NT32 firmware list\r
24    Add the Shell.INF to the end of the list of DXE modules.\r
25 \r
26 5. Build NT32\r
27 \r
28 ============================================================================\r
29                           KNOWN LIMITATIONS\r
30 ============================================================================\r
31 1. Redirecting StdErr is not completely functional.\r
32 2. CTRL-C is not functional.\r
33 \r
34 ============================================================================\r