tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

BaseTools: Update ReadMe.txt to match current functionality 

ReadMe.txt contained outdated information. Update it to match current
functionality (e.g. sqlite3 is no longer used), and convert the
formatting from ad-hoc to reStructuredText.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>

Reviewed-by: Bob Feng <bob.c.feng@intel.com>
This commit is contained in:
Rebecca Cran 2020-07-08 07:13:14 +08:00 committed by mergify[bot]
parent 17bd834eb5
commit a8ae714d4a
1 changed files with 16 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
BaseTools/ReadMe.txt
View File

@ -1,47 +1,41 @@
This directory contains the next generation of EDK II build tools and template files. This directory contains the EDK II build tools and template files.
Templates are located in the Conf directory, while the tools executables for Templates are located in the Conf directory, while the tools executables for
Microsoft Windows 32-bit Operating Systems are located in the Bin\Win32 directory, other Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other
directory contains tools source. directory contains tools source.
1. Build step to generate the binary tools. Build step to generate the binary tools
---------------------------------------
=== Windows/Visual Studio Notes === Windows/Visual Studio Notes
===========================
To build the BaseTools, you should run the standard vsvars32.bat script To build the BaseTools, you should run the standard vsvars32.bat script
from your preferred Visual Studio installation or you can run get_vsvars.bat from your preferred Visual Studio installation or you can run get_vsvars.bat
to use latest automatically detected version. to use latest automatically detected version.
In addition to this, you should set the following environment variables: In addition to this, you should set the following environment variables::
* EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree * EDK_TOOLS_PATH - Path to the BaseTools sub directory under the edk2 tree
* BASE_TOOLS_PATH - The directory where the BaseTools source is located. * BASE_TOOLS_PATH - The directory where the BaseTools source is located.
(It is the same directory where this README.txt is located.) (It is the same directory where this README.rst is located.)
After this, you can run the toolsetup.bat file, which is in the same After this, you can run the toolsetup.bat file, which is in the same
directory as this file. It should setup the remainder of the environment, directory as this file. It should setup the remainder of the environment,
and build the tools if necessary. and build the tools if necessary.
Please also refer to the 'BuildNotes.txt' file for more information on Please also refer to the ``BuildNotes.txt`` file for more information on
building under Windows. building under Windows.
=== Unix-like operating systems === Unix-like operating systems
===========================
To build on Unix-like operating systems, you only need to type 'make' in To build on Unix-like operating systems, you only need to type ``make`` in
the base directory of the project. the base directory of the project.
=== Ubuntu Notes === Ubuntu Notes
============
On Ubuntu, the following command should install all the necessary build On Ubuntu, the following command should install all the necessary build
packages to build all the C BaseTools: packages to build all the C BaseTools::
sudo apt-get install build-essential uuid-dev sudo apt install build-essential uuid-dev
=== Python sqlite3 module ===
On Windows, the cx_freeze will not copy the sqlite3.dll to the frozen
binary directory (the same directory as build.exe and GenFds.exe).
Please copy it manually from <PythonHome>\DLLs.
The Python distributed with most recent Linux will have sqlite3 module
built in. If not, please install sqlit3 package separately.
26-OCT-2011