Update readme format

[mirror_edk2.git] / ShellPkg / Readme.txt

diff --git a/ShellPkg/Readme.txt b/ShellPkg/Readme.txt
new file mode 100644 (file)
index 0000000..945d30a
--- /dev/null
+++ b/ShellPkg/Readme.txt
@@ -0,0 +1,34 @@
+============================================================================\r
+                                 OVERVIEW\r
+============================================================================\r
+The UEFI 2.0 shell provides a standard pre-boot command line processor.\r
+It is similar to the EDK EFI Shell or a *nix command line parser.\r
+\r
+============================================================================\r
+                    HOW TO INCORPORATE THIS SHELL INTO NT32\r
+============================================================================\r
+The instructions below are included as a sample and template on how a \r
+developer may integrate this code into an existing platform:\r
+\r
+1. Add this shell build to the NT32 build:\r
+   Add the shell.inf to the [components] section as it is in the ShellPkg.dsc.\r
+\r
+2. Update system PCDs to support this new module\r
+   Update the PCD as follows using the Shell's PCD:\r
+   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1 }\r
+\r
+3. Remove the old shell from the NT32 Firmware list\r
+   Remove the FILE APPLICATION section for the old shell.\r
+\r
+4. Add this shell to the NT32 firmware list\r
+   Add the Shell.INF to the end of the list of DXE modules.\r
+\r
+5. Build NT32\r
+\r
+============================================================================\r
+                          KNOWN LIMITATIONS\r
+============================================================================\r
+1. Redirecting StdErr is not completely functional.\r
+2. CTRL-C is not functional.\r
+\r
+============================================================================\r