Replace EFI_MAX() with MAX()

[mirror_edk2.git] / BaseTools / ReadMe.txt

This directory contains the next generation of EDK II build tools and template files.\r
Templates are located in the Conf directory, while the tools executables for\r
Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory.\r
\r
The binary tools will be updated only after passing developer testing.\r
\r
The BaseTools package will be updated with new tools only after all testing on a set\r
of binary tools has successfully completed.\r
\r
Current state of the tools is Proto-Type - not all tool functions have been implemented\r
and there may be bugs in these tools.  These tools are under constant development at\r
this time.\r
\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