summaryrefslogtreecommitdiff
path: root/ShellPkg/Readme.txt
diff options
context:
space:
mode:
authorhhtian <hhtian@6f19259b-4bc3-4df7-8a09-765794883524>2010-09-16 00:43:45 +0000
committerhhtian <hhtian@6f19259b-4bc3-4df7-8a09-765794883524>2010-09-16 00:43:45 +0000
commitd18221e82e2da3d46e88132929c698b4f3b16cfb (patch)
tree95d109ffb231158d9ff847d08534bd638fb7916d /ShellPkg/Readme.txt
parentc9325700d0ef25eaf45077928af3f93b15ac5fe0 (diff)
downloadedk2-platforms-d18221e82e2da3d46e88132929c698b4f3b16cfb.tar.xz
Update readme format
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10878 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg/Readme.txt')
-rw-r--r--ShellPkg/Readme.txt34
1 files changed, 34 insertions, 0 deletions
diff --git a/ShellPkg/Readme.txt b/ShellPkg/Readme.txt
new file mode 100644
index 0000000000..945d30a2aa
--- /dev/null
+++ b/ShellPkg/Readme.txt
@@ -0,0 +1,34 @@
+============================================================================
+ OVERVIEW
+============================================================================
+The UEFI 2.0 shell provides a standard pre-boot command line processor.
+It is similar to the EDK EFI Shell or a *nix command line parser.
+
+============================================================================
+ 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. Add this shell build to the NT32 build:
+ Add the shell.inf to the [components] section as it is in the ShellPkg.dsc.
+
+2. 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 }
+
+3. Remove the old shell from the NT32 Firmware list
+ Remove the FILE APPLICATION section for the old shell.
+
+4. Add this shell to the NT32 firmware list
+ Add the Shell.INF to the end of the list of DXE modules.
+
+5. Build NT32
+
+============================================================================
+ KNOWN LIMITATIONS
+============================================================================
+1. Redirecting StdErr is not completely functional.
+2. CTRL-C is not functional.
+
+============================================================================