]> git.proxmox.com Git - mirror_edk2.git/commitdiff
BaseTools: rename ReadMe.txt to ReadMe.rst
authorRebecca Cran <rebecca@bsdio.com>
Tue, 7 Jul 2020 23:13:15 +0000 (07:13 +0800)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Tue, 21 Jul 2020 04:12:32 +0000 (04:12 +0000)
The ReadMe file is now RST, so update the filename extension to match.

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>
BaseTools/ReadMe.rst [new file with mode: 0644]
BaseTools/ReadMe.txt [deleted file]

diff --git a/BaseTools/ReadMe.rst b/BaseTools/ReadMe.rst
new file mode 100644 (file)
index 0000000..de85ca4
--- /dev/null
@@ -0,0 +1,41 @@
+This directory contains the EDK II build tools and template files.\r
+Templates are located in the Conf directory, while the tools executables for\r
+Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other\r
+directory contains tools source.\r
+\r
+Build step to generate the binary tools\r
+---------------------------------------\r
+\r
+Windows/Visual Studio Notes\r
+===========================\r
+\r
+To build the BaseTools, you should run the standard vsvars32.bat script\r
+from your preferred Visual Studio installation or you can run get_vsvars.bat\r
+to use latest automatically detected version.\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.rst is located.)\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
+Unix-like operating systems\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
+\r
+On Ubuntu, the following command should install all the necessary build\r
+packages to build all the C BaseTools::\r
+\r
+ sudo apt install build-essential uuid-dev\r
diff --git a/BaseTools/ReadMe.txt b/BaseTools/ReadMe.txt
deleted file mode 100644 (file)
index de85ca4..0000000
+++ /dev/null
@@ -1,41 +0,0 @@
-This directory contains the EDK II build tools and template files.\r
-Templates are located in the Conf directory, while the tools executables for\r
-Microsoft Windows Operating Systems are located in the Bin\\Win32 directory, other\r
-directory contains tools source.\r
-\r
-Build step to generate the binary tools\r
----------------------------------------\r
-\r
-Windows/Visual Studio Notes\r
-===========================\r
-\r
-To build the BaseTools, you should run the standard vsvars32.bat script\r
-from your preferred Visual Studio installation or you can run get_vsvars.bat\r
-to use latest automatically detected version.\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.rst is located.)\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
-Unix-like operating systems\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
-\r
-On Ubuntu, the following command should install all the necessary build\r
-packages to build all the C BaseTools::\r
-\r
- sudo apt install build-essential uuid-dev\r