BaseTools: make build report tolerant of FVs specified by name

[mirror_edk2.git] / BaseTools / gcc / README.txt

diff --git a/BaseTools/gcc/README.txt b/BaseTools/gcc/README.txt
index 3b9428dbe7f85479f6152d1821be7a0c649fa1bd..ea7dd64576749afd9026555e795b6297d25554ec 100644 (file)
--- a/BaseTools/gcc/README.txt
+++ b/BaseTools/gcc/README.txt
@@ -1,21 +1,57 @@
-You may run these scripts to build a Tiano Cross compiler. They have been\r
-tested on Cygwin, OS X and Linux. You must modify these scripts to make them\r
-work on your system. You may need to install additional tools on your system to\r
-make the scripts work.\r
-\r
-You will need\r
-\r
-  A recent version (3.0 or later should be fine) of gcc that is able to produce\r
-    executables for the machine that you want to run this compiler on (the host\r
-    machine).\r
-  wget or curl\r
-  tar\r
-  bzip\r
-  gzip\r
-  bash\r
-  and possibly others\r
-\r
-CYGWIN Notes\r
+You may run these scripts to build a UEFI/PI gcc cross compiler.\r
+\r
+Cross compilers built with these scripts are tested on\r
+Linux, OS X and Cygwin.\r
+\r
+Please note that you may need to modify your edk2 tree's Conf/tools_def.txt\r
+file to point to the location where you installed the cross compiler.\r
+\r
+=== tianoCross-gcc-4.1 ===\r
+\r
+This script will build an x86 (ia32) cross compiler.\r
+\r
+The results of this script are very similar to the 'mingw' cross compiler\r
+which is commonly available on linux and OS X.  But, since the cross\r
+compiler produced by this script is tested, it is the only 'supported' way\r
+to build UEFI/PI images.\r
+\r
+To use this script, you will need:\r
+\r
+ * A recent version (3.0 or later should be fine) of gcc that is able to produce\r
+   executables for the machine that you want to run this compiler on (the host\r
+   machine).\r
+ * wget or curl\r
+ * tar\r
+ * bzip\r
+ * gzip\r
+ * bash\r
+ * As well as (possibly) others tools and development packages\r
+\r
+=== x86_64-mingw-gcc-build.py ==\r
+\r
+This script will build an x86_64 (x64/Intel 64/amd64) cross compiler.\r
+\r
+To use this script, you will need:\r
+\r
+ * A recent version (3.0 or later should be fine) of gcc that is able to\r
+   produce executables for the machine that you want to run this compiler\r
+   on (the host machine).\r
+ * Python 2.5\r
+ * texinfo\r
+ * bison\r
+ * flex\r
+ * libmpfr\r
+ * libgmp\r
+ * As well as (possibly) others tools and development packages\r
+\r
+=== Ubuntu Notes ===\r
+\r
+On Ubuntu, the following command should install all the necessary build\r
+packages to utilize the x86_64-mingw-gcc-build.py script:\r
+\r
+  sudo apt-get install build-essential texinfo bison flex libgmp3-dev libmpfr-dev\r
+\r
+=== CYGWIN Notes ===\r
 \r
 You should setup cygwin to use binmode on all mounts. When you initially\r
 install cygwin it gives you the choice of Unix file mode (recommended) or DOS\r