BaseTools/README.txt:

  Some documentation for building the BaseTools project.

git-svn-id: https://buildtools.tianocore.org/svn/buildtools/trunk/BaseTools@1036 7335b38e-4728-0410-8992-fb3ffe349368

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..6fa800c
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,34 @@
+\r
+This file decribes how to build the BaseTools project.\r
+\r
+=== Windows/Visual Studio Notes ===\r
+\r
+To build the BaseTools, you should run the standard vsvars32.bat script.\r
+\r
+In addition to this, you should set the following environment variables:\r
+\r
+ * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree\r
+ * BASE_TOOLS_PATH - The directory where the BaseTools source is located.\r
+   (It is the same directory where this README.txt is located.)\r
+ * PYTHON_FREEZER_PATH - Path to where the python freezer tool is installed\r
+\r
+After this, you can run the toolsetup.bat file, which is in the same\r
+directory as this file.  It should setup the remainder of the environment,\r
+and build the tools if necessary.\r
+\r
+Please also refer to the 'BuildNotes.txt' file for more information on\r
+building under Windows.\r
+\r
+=== \r
+\r
+To build on Unix-like operating systems, you only need to type 'make' in\r
+the base directory of the project.\r
+\r
+=== Ubuntu Notes ===\r
+\r
+On Ubuntu, the following command should install all the necessary build\r
+packages to build all the C BaseTools:\r
+\r
+  sudo apt-get install build-essentials uuid-dev\r
+\r
+\r