ArmPkg: move ARM version of SetMemoryAttributes to ArmMmuLib

[mirror_edk2.git] / DuetPkg / ReadMe.txt

diff --git a/DuetPkg/ReadMe.txt b/DuetPkg/ReadMe.txt
index d7ad3d601785188c0cbdf54efcbb3e89f9902a24..f894d94579ccd8b457f30e89d2b389f0062daa69 100644 (file)
--- a/DuetPkg/ReadMe.txt
+++ b/DuetPkg/ReadMe.txt
@@ -4,28 +4,22 @@ A. Build DUET image on Windows Platform
 ========================================\r
 1. Tools preparation\r
 \r
 ========================================\r
 1. Tools preparation\r
 \r

-To build DUET image, following tools are required:\r
+  To build DUET image, Visual Studio is required:\r
+  1). Base on below link to create Visual Studio build environment.\r
+      https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems\r

 \r
 \r

-  1). *Visual Studio 2005*\r
-      Assume installed at <VS_PATH>,\r
-      e.g.: C:\Program Files\Microsoft Visual Studio .NET 2003\.\r
-  2). WinDDK\r
-      Assume installed at <WIN_DDK_PATH>, e.g.: C:\WINDDK\3790.1830\.\r
-\r
-2. Build steps\r
-\r
-2.1 Build Duet Platform module\r
+2. Build Duet Platform module\r

 \r
   1). run cmd.exe to open command line window.\r
   2). enter workspace root directory such as c:\edk2_tree\r
 \r
   1). run cmd.exe to open command line window.\r
   2). enter workspace root directory such as c:\edk2_tree\r

-  2). run "edksetup.bat"\r
-  3). run "build -p DuetPkg\DuetPkg.dsc -a IA32" for IA32 architecture platform or\r
-          "build -p DuetPkg\DuetPkg.dsc -a X64" for X64 architecture platform.\r
+  3). set the environment variable EDK_TOOLS_BIN to point at the BaseTools binaries directory\r
+      i.e., "set EDK_TOOLS_BIN=c:\edk2-BaseTools-win32"\r
+  4). run "edksetup.bat"\r
+  5). run "build -p DuetPkg\DuetPkgIa32.dsc -a IA32 -t VS2015x86" for IA32 architecture platform (using 64-bit VS2015 for example) or\r
+          "build -p DuetPkg\DuetPkgX64.dsc -a X64 -t VS2015x86" for X64 architecture platform.\r
+\r
+  NOTE: The post build script 'PostBuild.sh' will be automatically called after the build command.\r

 \r
 \r

-2.2 Execute post build actions\r
-  1). enter <Workspace>\DuetPkg directory.\r
-  2). run "PostBuild.bat IA32" for IA32 architecture platform or\r
-          "PostBuild.bat X64" for X64 architecture platform.\r

 \r
 Create bootable disk\r
 ======================\r
 \r
 Create bootable disk\r
 ======================\r


@@ -56,34 +50,35 @@ B. Build DUET image on Linux Platform
 ======================================\r
 1. Tools preparation\r
 \r
 ======================================\r
 1. Tools preparation\r
 \r

-  To build DUET image, GCC44 is required:\r
-  1). Base on below link to create GCC44 build environment.\r
-      http://tianocore.sourceforge.net/wiki/Using_EDK_II_with_Native_GCC\r
+  To build DUET image, GCC installation (4.4+) is required:\r
+  1). Base on below link to create GCC build environment.\r
+      https://github.com/tianocore/tianocore.github.io/wiki/Using-EDK-II-with-Native-GCC\r

 \r
 \r

-2. Build steps\r
-\r
-2.1 Build Duet Platform module\r
+2. Build Duet Platform module\r

 \r
   1). Open the terminal.\r
   2). enter workspace root directory such as /edk2_tree\r
   3). run ". edksetup.sh BaseTools"\r
 \r
   1). Open the terminal.\r
   2). enter workspace root directory such as /edk2_tree\r
   3). run ". edksetup.sh BaseTools"\r

-  4). run "build -p DuetPkg/DuetPkg.dsc -a IA32 -t GCC44" for IA32 architecture platform or\r
-          "build -p DuetPkg/DuetPkg.dsc -a X64 -t GCC44" for X64 architecture platform.\r
-\r
-2.2 Execute post build actions\r
-  1). enter /edk2_tree/DuetPkg directory.\r
-  2). run "./PostBuild.sh IA32 GCC44" for IA32 architecture platform or\r
-          "./PostBuild.sh X64 GCC44" for X64 architecture platform.\r
+  4). run "build -p DuetPkg/DuetPkgIa32.dsc -a IA32 -t GCC49" for IA32 architecture platform (using GCC 4.9 for example) or\r
+          "build -p DuetPkg/DuetPkgX64.dsc -a X64 -t GCC49" for X64 architecture platform.\r

 \r
 \r

- NOTE: After post build action, you should check the size of EfiLdr at $WORKSPACE/Build/DuetPkg/DEBUG_GCC44 directory, it must less than 470k.\r
-       If not, you should manually remove some unnecessary drivers at DuetPkg.fdf file.\r
+  NOTE: The post build script 'PostBuild.sh' will be automatically called after the build command.\r
+        After post build action, you should check the size of EfiLdr at $WORKSPACE/Build/DuetPkgIA32(DuetPkgX64)/DEBUG_GCC49 directory, it must less than 470k.\r
+        If not, you should manually remove some unnecessary drivers at DuetPkg.fdf file.\r

 \r
 3. Create bootable disk\r
    The following steps are same for IA32 architecture platform or X64 architecture platform.\r
 \r
 3. Create bootable disk\r
    The following steps are same for IA32 architecture platform or X64 architecture platform.\r

-   Now only support floopy.\r

 \r
 \r

-   3.1 Create floppy boot disk\r
-      1). enter /edk2_tree/DuetPkg directory.\r
-      2). Insert a floppy disk to drive\r
-      3). run "CreateBootDisk.sh" to build floppy drive\r
-          such as "./CreateBootDisk.sh floppy /media/floppy0 /dev/fd0 FAT12 IA32"\r
+3.1 Create floppy boot disk\r
+  1). enter /edk2_tree/DuetPkg directory.\r
+  2). Insert a floppy disk to drive\r
+  3). run "CreateBootDisk.sh" to build floppy drive\r
+      such as "./CreateBootDisk.sh floppy /media/floppy0 /dev/fd0 FAT12 IA32"\r
+\r
+3.2 Create usb boot disk\r
+  1). enter /edk2_tree/DuetPkg directory.\r
+  2). Plugin usb disk\r
+  3). run "CreateBootDisk.sh" to build usb drive\r
+      such as "./CreateBootDisk.sh usb /media/usb0 /dev/sdb0 FAT16 IA32"\r
+  4). UnPlug usb disk and plugin it again.\r
+  5). run "./CreateBootDisk.sh usb /media/usb0 /dev/sdb0 FAT16 IA32 step2"\r