summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Kubacki <michael.kubacki@microsoft.com>2022-12-02 11:46:09 -0500
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2022-12-16 22:17:18 +0000
commit30697b94fd5e2911cef33709c4c88d11830927bb (patch)
treeeb5f903a144e0c3edece44bec5d138dea520e4a9
parentf70f493d1b4136f0c2dc2cb5b0419d7824979d99 (diff)
downloadedk2-30697b94fd5e2911cef33709c4c88d11830927bb.tar.gz
edk2-30697b94fd5e2911cef33709c4c88d11830927bb.tar.bz2
edk2-30697b94fd5e2911cef33709c4c88d11830927bb.zip
BaseTools: Add reference to new build instructions
Adds a reference to the new build instructions on the TianoCore wiki that currently describe building with containers and Stuart. Cc: Bob Feng <bob.c.feng@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Cc: Yuwei Chen <yuwei.chen@intel.com> Cc: Sean Brogan <sean.brogan@microsoft.com> Cc: Michael D Kinney <michael.d.kinney@intel.com> Cc: Liming Gao <gaoliming@byosoft.com.cn> Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> Acked-by: Ard Biesheuvel <ardb@kernel.org> Reviewed-by: Gerd Hoffmann <kraxel@redhat.com>
-rw-r--r--BaseTools/ReadMe.rst13
1 files changed, 10 insertions, 3 deletions
diff --git a/BaseTools/ReadMe.rst b/BaseTools/ReadMe.rst
index de85ca4be6..592be51b1f 100644
--- a/BaseTools/ReadMe.rst
+++ b/BaseTools/ReadMe.rst
@@ -1,3 +1,13 @@
+::
+
+ Note: New build instructions are available. It is recommended to start with
+ the new instructions if learning how to build edk2 and/or BaseTools for the
+ first time. This page is retained for reference.
+
+New instructions: `Build Instructions`_
+
+.. _`Build Instructions`: https://github.com/tianocore/tianocore.github.io/wiki/Build-Instructions
+
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 Operating Systems are located in the Bin\\Win32 directory, other
@@ -23,9 +33,6 @@ 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
-building under Windows.
-
Unix-like operating systems
===========================