diff options
| author | Rebecca Cran <rebecca@bsdio.com> | 2020-07-08 07:13:14 +0800 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2020-07-21 04:12:32 +0000 |
| commit | a8ae714d4aa20c457e4674c1fb61ffa6b7bfdbeb (patch) | |
| tree | 695716f7b193a653014c2c2692cda0a57e79ec16 | |
| parent | 17bd834eb5fd97699fbbcd146c7788df9e42030c (diff) | |
| download | edk2-a8ae714d4aa20c457e4674c1fb61ffa6b7bfdbeb.zip edk2-a8ae714d4aa20c457e4674c1fb61ffa6b7bfdbeb.tar.gz edk2-a8ae714d4aa20c457e4674c1fb61ffa6b7bfdbeb.tar.bz2 | |
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>
| -rw-r--r-- | BaseTools/ReadMe.txt | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt index b81bd90..de85ca4 100644 --- a/BaseTools/ReadMe.txt +++ b/BaseTools/ReadMe.txt @@ -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
-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.
-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
from your preferred Visual Studio installation or you can run get_vsvars.bat
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
* 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
directory as this file. It should setup the remainder of the environment,
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.
-=== 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.
-=== Ubuntu Notes ===
+Ubuntu Notes
+============
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
-
-=== 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
+ sudo apt install build-essential uuid-dev
|