From: Michael Kubacki <michael.kubacki@microsoft.com>
Date: Fri, 2 Dec 2022 16:46:09 +0000 (-0500)
Subject: BaseTools: Add reference to new build instructions
X-Git-Tag: edk2-stable202302~239
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=30697b94fd5e2911cef33709c4c88d11830927bb

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>
---

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
 ===========================