Added usage and notes
authorjwang36 <jwang36@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 25 Jun 2007 17:19:31 +0000 (17:19 +0000)
committerjwang36 <jwang36@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 25 Jun 2007 17:19:31 +0000 (17:19 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@2734 6f19259b-4bc3-4df7-8a09-765794883524

BaseTools/ReadMe.txt

index 81c52ef..55fb408 100644 (file)
@@ -11,4 +11,26 @@ Current state of the tools is Proto-Type - not all tool functions have been impl
 and there may be bugs in these tools.  These tools are under constant development at\r
 this time.\r
 \r
 and there may be bugs in these tools.  These tools are under constant development at\r
 this time.\r
 \r
-20-Jun-2007\r
+BaseTools Simple Usage:\r
+1) Change the directory to the EDK2 root directory, where the edksetup.bat is\r
+2) Run "edksetup.bat NewBuild"\r
+3) Set the ACTIVE_PLATFORM to your desired platform description file \r
+   (%WORKSPACE%\Conf\target.txt)\r
+4) To build platform, run "build" command in non-module directory\r
+5) To build module individually, run "build" command in module directory, i.e. where the \r
+   *.inf file is\r
+\r
+Notes:\r
+1) Only *.efi files can be generated. Flash image cannot be generated at present.\r
+2) Only "clean" and "cleanall" build target are supported, in both top level \r
+   makefile and module's makefile. \r
+3) Not all tool chains and target architectures are tested. Due to both tools \r
+   and source code limitations, ther must be bugs in it. Please report any issue \r
+        ASAP so we can fix it soon.\r
+4) The tree structure generated by build tools is similar to Ant build system.\r
+5) Makefile can be called directly by nmake for both top level platform and module. But\r
+   after you call "nmake cleanall", you have to call "build" command to rebuild platform\r
+        or modules because the AutoGen.* files have been be removed. The "makefile" itself\r
+        cannot generate AutoGen.* files. Only "build" command can.\r
+\r
+25-Jun-2007\r