Update readme format
authorhhtian <hhtian@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 16 Sep 2010 00:43:45 +0000 (00:43 +0000)
committerhhtian <hhtian@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 16 Sep 2010 00:43:45 +0000 (00:43 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10878 6f19259b-4bc3-4df7-8a09-765794883524

ShellPkg/Readme.txt [new file with mode: 0644]
ShellPkg/UDK2010.UP2.Shell.txt [deleted file]

diff --git a/ShellPkg/Readme.txt b/ShellPkg/Readme.txt
new file mode 100644 (file)
index 0000000..945d30a
--- /dev/null
@@ -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
diff --git a/ShellPkg/UDK2010.UP2.Shell.txt b/ShellPkg/UDK2010.UP2.Shell.txt
deleted file mode 100644 (file)
index f39bd75..0000000
+++ /dev/null
@@ -1,89 +0,0 @@
-============================================================================\r
-UEFI Shell 2.0 implementation release notes.\r
-September 13, 2010\r
-============================================================================\r
-============================================================================\r
-                                   DISCLAIMER\r
-============================================================================\r
-This release note as well as the software described in it is furnished under \r
-license and may only be used or copied in accordance with the terms of the \r
-license. The information in this manual is furnished for informational use \r
-only, is subject to change without notice, and should not be construed as a \r
-commitment by Intel Corporation.\r
-\r
-Intel Corporation assumes no responsibility or liability for any errors or \r
-inaccuracies that may appear in this document or any software that may be \r
-provided in association with this document.\r
-\r
-Except as permitted by such license, no part of this document may be \r
-reproduced, stored in a retrieval system, or transmitted in any form or by \r
-any means without the express written consent of Intel Corporation.\r
-\r
-============================================================================\r
-                              ADDITIONAL DISCLAIMER\r
-============================================================================\r
-This code is based upon the EDK II code base as found on the UEFI Open \r
-Source Community Website at http://www.tianocore.org.\r
-\r
-============================================================================\r
-                                  CONTENTS\r
-============================================================================\r
-* Overview\r
-* How to build shell\r
-* Known limitations\r
-* Incorporation\r
-\r
-============================================================================\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 BUILD SHELL\r
-============================================================================\r
-1. Tools preparation\r
-  1). *Visual Studio 2005* or Intel(r) Compiler 9.1\r
-      \r
-\r
-2. Source preparation\r
-  1). Extract .zip (or later) to root of EDK II workspace\r
-\r
-3. Build steps\r
-  1) run edksetup script\r
-  2) run build -p ShellPlg\ShellPkg.dsc\r
-\r
-============================================================================\r
-                            KNOWN LIMITATIONS\r
-============================================================================\r
-1. Redirecting StdErr is not completely functional.\r
-\r
-2. This uses errata approved by the USHT/USWG, but not yet published by UEFI.\r
-\r
-3. Online help may be incomplete and examples may be slightly out of date.\r
-\r
-4. CTRL-C is not functional.\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
-1) Update system PCDs to support this new module\r
-Update the PCD as follows using the Shell's PCD:\r
-\r
-  gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1 }\r
-\r
-2) Remove the old shell from the NT32 Firmware list \r
-Remove the FILE APPLICATION section for the old shell.\r
-\r
-3) Add this shell to the NT32 firmware list\r
-Add the Shell.INF to the end of the list of DXE modules.\r
-\r
-4) Build NT32 (per instructions provided with EDK II/UDK2010)\r
-\r
-============================================================================\r