From nobody Sat Nov 2 14:34:56 2024 Delivered-To: importer@patchew.org Received-SPF: none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) client-ip=198.145.21.10; envelope-from=edk2-devel-bounces@lists.01.org; helo=ml01.01.org; Authentication-Results: mx.zoho.com; spf=none (zoho.com: 198.145.21.10 is neither permitted nor denied by domain of lists.01.org) smtp.mailfrom=edk2-devel-bounces@lists.01.org; Return-Path: Received: from ml01.01.org (ml01.01.org [198.145.21.10]) by mx.zohomail.com with SMTPS id 148745832440084.4191557820003; Sat, 18 Feb 2017 14:52:04 -0800 (PST) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id 4A8AA8218B; Sat, 18 Feb 2017 14:52:02 -0800 (PST) Received: from muon.cran.org.uk (muon.bluestop.org [IPv6:2605:7700:0:8:1:0:4a32:3323]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 2AD318218A for ; Sat, 18 Feb 2017 14:52:01 -0800 (PST) Received: from muon.bluestop.org (localhost [127.0.0.1]) by muon.cran.org.uk (Postfix) with ESMTP id C7D9A7BAAE; Sat, 18 Feb 2017 22:51:59 +0000 (UTC) Received: from muon.cran.org.uk ([127.0.0.1]) by muon.bluestop.org (muon.bluestop.org [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id ZlB-I8G-ZbPD; Sat, 18 Feb 2017 22:51:57 +0000 (UTC) Received: from localhost.localdomain (unknown [IPv6:2601:681:4302:4d07:6580:bf1a:e1e7:dd88]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-SHA256 (128/128 bits)) (No client certificate requested) by muon.cran.org.uk (Postfix) with ESMTPSA; Sat, 18 Feb 2017 22:51:57 +0000 (UTC) X-Original-To: edk2-devel@lists.01.org From: Rebecca Cran To: edk2-devel@lists.01.org, david.wei@intel.com, mang.guo@intel.com, vincent.zimmer@intel.com, mike.wu@intel.com, shifeix.a.lu@intel.com Date: Sat, 18 Feb 2017 15:51:41 -0700 Message-Id: <20170218225141.12124-1-rebecca@bluestop.org> X-Mailer: git-send-email 2.11.0.windows.1 MIME-Version: 1.0 Subject: [edk2] [PATCH] Reformat ReadMe.MD with markdown (github) and simplify instructions X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Errors-To: edk2-devel-bounces@lists.01.org Sender: "edk2-devel" X-ZohoMail: RSF_4 Z_629925259 SPT_0 The formatting of ReadMe.MD on GitHub wasn't very nice, with steps running into one another. This change reformats the text to use GitHub Flavored Markdown. It also simplifies a few of the steps, for example combining the git clone and rename into a single command. --- ReadMe.MD | 163 ++++++++++++++++++++++++++++++----------------------------= ---- 1 file changed, 78 insertions(+), 85 deletions(-) diff --git a/ReadMe.MD b/ReadMe.MD index ec55d6569767..15638503bc91 100644 --- a/ReadMe.MD +++ b/ReadMe.MD @@ -1,138 +1,131 @@ =EF=BB=BF This code base is designed for the MinnowBoard v3 platform using the Intel= (R) Atom(tm) Processor E3900 Series. =20 -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D - INDEX=20 -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D +# INDEX + 1. HOW TO CREATE A FULL SOURCE TREE 2. HOW TO BUILD (WINDOWS ENVIRONMENT) 3. MAINTAINERS - =20 -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D -1. HOW TO CREATE A FULL SOURCE TREE=20 -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D -1) Create a new folder (directory) on the root of your local development m= achine + +## 1. HOW TO CREATE A FULL SOURCE TREE + +1. Create a new folder (directory) on the root of your local development m= achine for use as your work space (this example uses "C:\MyWorkspace"). =20 NOTE: Some code paths are very long, and placing the working directory = too deep below the ROOT directory may cause the path to be longer tha= n the=20 operating system or file system's maximum path length. =20 -2) Get MinnowBoard v3 branch from GitHub with the following command. - a. git clone https://github.com/tianocore/edk2-platforms.git -b devel-M= innowBoard3 +2. Get MinnowBoard v3 branch from GitHub with the following command. + * `git clone -b devel-MinnowBoard3 https://github.com/tianocore/edk2-pl= atforms.git` =20 Once the download completes, all EDK II packages and files will be found under the "C:\MyWorkspace\edk2-platforms" directory. =20 -3) Get the BaseTools binary and copy them to BaseTools binary folder. - a. git clone https://github.com/tianocore/edk2-BaseTools-win32.git - b. Enter folder edk2-BaseTools-win32 - b. git checkout f0c97b7716ce92f1fc657f87f29bcc9170e5eb1f - c. Rename folder name from "edk2-BaseTools-win32/" to "win32/" and copy - win32/ to the BaseTools Binary folder. - (C:\MyWorkspace\edk2-platforms\BaseTools\Bin\) +3. Get the BaseTools binary and copy them to BaseTools binary folder. + 1. Enter folder BaseTools\Bin + 2. `git clone https://github.com/tianocore/edk2-BaseTools-win32.git Win= 32` + 3. Enter folder Win32 + 4. `git checkout f0c97b7716ce92f1fc657f87f29bcc9170e5eb1f` =20 -4) Get the Intel(R) Firmware Support Package(Intel FSP) - a. Run "git clone -b ApolloLake https://github.com/IntelFsp/FSP.git" to= download FSP. - b. Copy the ApolloLakeFspBinPkg to the folder +4. Get the Intel(R) Firmware Support Package(Intel FSP) + 1. Run `git clone -b ApolloLake https://github.com/IntelFsp/FSP.git` to= download FSP. + 2. Copy the ApolloLakeFspBinPkg to the folder "C:\MyWorkspace\edk2-platforms\Silicon\BroxtonSoC\BroxtonFspPkg". =20 -5) Install UEFI UNDI driver: - a. Download PREBOOT.EXE Version 21.1 from the "Intel=C2=AE Ethernet Con= nections=20 +5. Install UEFI UNDI driver: + 1. Download PREBOOT.EXE Version 21.1 from the "Intel=C2=AE Ethernet Con= nections Boot Utility, Preboot Images, and EFI Drivers" page. https://downloadcenter.intel.com/download/19186/Intel-Ethernet-Conne= ctions-Boot-Utility-Preboot-Images-and-EFI-Drivers - b. Install PREBOOT.EXE into the default folder (C:\Intel21.1). - c. Copy the UEFI x64 PCI-E gigabit driver (C:\Intel21.1\APPS\EFI\EFIx64= \EnnnnX3.EFI, + 2. Install PREBOOT.EXE into the default folder (C:\Intel21.1). + 3. Copy the UEFI x64 PCI-E gigabit driver (C:\Intel21.1\APPS\EFI\EFIx64= \EnnnnX3.EFI, where "nnnn" is the driver version number) to the platform package d= irectory below, create the folder if it does not exist: "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Bi= naries\UNDI\I210PcieUndiDxe" - d. Open the file "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatfor= mPkg\PlatformPkg.fdf" + 4. Open the file "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatfor= mPkg\PlatformPkg.fdf" and change the UNDI driver file name reference with the one that was= downloaded: SECTION PE32 =3D BroxtonPlatformPkg/Common/Binaries/UNDI/I210Pcie= UndiDxe/E7006X3.EFI =20 -6) Install the NASM assembly language compiler: = =20 - a. Download NASM 2.12.02 binaries:=20 - http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win32/nasm-2.12.02= -win32.zip - http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win64/nasm-2.12.02= -win64.zip - b. Unzip the 32-bit & 64-bit versions of nasm.exe to the directories li= sted below, +6. Install the NASM assembly language compiler: + 1. Download NASM 2.12.02 binaries: + * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win32/nasm-2.12.= 02-win32.zip + * http://www.nasm.us/pub/nasm/releasebuilds/2.12.02/win64/nasm-2.12.= 02-win64.zip + 2. Unzip the 32-bit & 64-bit versions of nasm.exe to the directories li= sted below, respectively, and create the folders if they do not exist: - "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\To= ols\nasm\Win32" - "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\To= ols\nasm\Win64" + * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\= Tools\nasm\Win32" + * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\= Tools\nasm\Win64" =20 -7) Install the ACPI Source Language (ASL) compiler: - a. Install the IASL 2016-09-30 compiler from acpica.org: +7. Install the ACPI Source Language (ASL) compiler: + 1. Install the IASL 2016-09-30 compiler from acpica.org: https://acpica.org/sites/acpica/files/iasl-win-20160930.zip - b. Unzip the "iasl.exe" file into the directory below, and create the f= older + 2. Unzip the "iasl.exe" file into the directory below, and create the f= older if it does not exist: - "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\To= ols\Iasl" + * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\= Tools\Iasl" =20 -8) Follow the instructions found in the "Patch-HOWTO.txt" file located in = the Workspace +8. Follow the instructions found in the "Patch-HOWTO.txt" file located in = the Workspace (e.g. "C:\MyWorkspace\edk2-platforms\Core\CryptoPkg\Library\OpensslLib\= Patch-HOWTO.txt") to install the OpenSSL source code and enable the CryptoPkg module. =20 =20 -9) Download MinnowBoard v3 Binary Object Modules - a. Download the "MinnowBoard_v3-0.60-Binary.Objects.zip" from the proje= ct page: - https://firmware.intel.com/projects/minnowboardv3 - b. Unzip and copy the two folders (A_Stepping, B_Stepping) into +9. Download MinnowBoard v3 Binary Object Modules + 1. Download the "MinnowBoard_v3-0.60-Binary.Objects.zip" from the proje= ct page: + * https://firmware.intel.com/projects/minnowboardv3 + 2. Unzip and copy the two folders (A_Stepping, B_Stepping) into the directory below, and create the folder if it does nto exist: - "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\Bi= naries\IFWI" + * "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\= Binaries\IFWI" + +## 2. HOW TO BUILD (WINDOWS ENVIRONMENT) =20 -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D -2. HOW TO BUILD (WINDOWS ENVIRONMENT) -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D Windows System Configuration: Microsoft Windows 7 Ultimate 64-bit* =20 -1) Setup Build Environment +1. Setup Build Environment =20 - 1) Install C compiler (Visual Studio .NET VS2013/VS2015) in the=20 - build machine. + 1. Install Visual Studio 2013/2015 on the build machine. =20 - 2) Install version Python 2.7.10 from: https://www.python.org/downloads= /release/python-2710/ - Make sure that a file with the extension of ".py" will be opened by = Python.exe. + 2. Install the latest Python 2 Release from: https://www.python.org/dow= nloads/windows/ + * Make sure that a file with the extension of ".py" will be opened b= y Python.exe. =20 -2) Build +2. Build =20 -2a) Build Steps (32-bit)=20 - 1) To build a 32-bit release version - Open a command prompt of Microsoft Visual Studio, such as "Developer= Command Prompt for VS2013"; - Type the command: "cd C:\MyWorkspace\edk2-platforms";=20 - Type the command: "BuildBIOS.bat /VS13 /IA32 Broxton Release" to bui= ld a release version. - (Please use "VS15" flag for Visual Studio 2015 build) + 2a. Build Steps (32-bit) + 1. To build a 32-bit release version + * Open a command prompt of Microsoft Visual Studio, such as "Develop= er Command Prompt for VS2013"; + * Type the command: `cd C:\MyWorkspace\edk2-platforms` + * Type the command: `BuildBIOS.bat /VS13 /IA32 Broxton Release` to b= uild a release version. + (Please use "VS15" flag for Visual Studio 2015 build) =20 - 2) To build a 32-bit debug version - Open a command prompt of Microsoft Visual Studio, such as "Developer= Command Prompt for VS2013"; - Type the command: "cd C:\MyWorkspace\edk2-platforms";=20 - Type the command: "BuildBIOS.bat /VS13 /IA32 Broxton Debug" to build= a debug version. - (Please use "VS15" flag for Visual Studio 2015 build) + 2. To build a 32-bit debug version + * Open a command prompt of Microsoft Visual Studio, such as "Develop= er Command Prompt for VS2013"; + * Type the command: `cd C:\MyWorkspace\edk2-platforms` + * Type the command: `BuildBIOS.bat /VS13 /IA32 Broxton Debug` to bui= ld a debug version. + (Please use "VS15" flag for Visual Studio 2015 build) =20 - 3) After the build successfully completes, the 8MB firmware binary imag= e will be located in the - following location on your local hard drive:=20 + 3. After the build successfully completes, the 8MB firmware binary ima= ge will be located in the + following location on your local hard drive: =20 "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\To= ols\Stitch" =20 -2b) Build Steps (64-bit)=20 - 1) To build a 64-bit release version - Open a command prompt of Microsoft Visual Studio, such as "Developer= Command Prompt for VS2013"; - Type the command: "cd C:\MyWorkspace\edk2-platforms";=20 - Type the command: "BuildBIOS.bat /VS13 /x64 Broxton Release" to buil= d a release version. - (Please use "VS15" flag for Visual Studio 2015 build) + 2b. Build Steps (64-bit) + 1. To build a 64-bit release version + * Open a command prompt of Microsoft Visual Studio, such as "Develop= er Command Prompt for VS2013"; + * Type the command: `cd C:\MyWorkspace\edk2-platforms` + * Type the command: `BuildBIOS.bat /VS13 /x64 Broxton Release` to bu= ild a release version. + (Please use "VS15" flag for Visual Studio 2015 build) =20 - 2) To build a 64-bit debug version - Open a command prompt of Microsoft Visual Studio, such as "Developer= Command Prompt for VS2013"; - Type the command: "cd C:\MyWorkspace\edk2-platforms";=20 - Type the command: "BuildBIOS.bat /VS13 /x64 Broxton Debug" to build = a debug version. - (Please use "VS15" flag for Visual Studio 2015 build) + 2. To build a 64-bit debug version + * Open a command prompt of Microsoft Visual Studio, such as "Develop= er Command Prompt for VS2013"; + * Type the command: `cd C:\MyWorkspace\edk2-platforms` + * Type the command: `BuildBIOS.bat /VS13 /x64 Broxton Debug` to buil= d a debug version. + (Please use "VS15" flag for Visual Studio 2015 build) =20 - 3) After the build successfully completes, the 8MB firmware binary imag= e will be located in the - following location on your local hard drive:=20 + 3. After the build successfully completes, the 8MB firmware binary ima= ge will be located in the + following location on your local hard drive: =20 "C:\MyWorkspace\edk2-platforms\Platform\BroxtonPlatformPkg\Common\To= ols\Stitch" =20 -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D - MAINTAINERS -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D -david.wei@intel.com -mang.guo@intel.com -vincent.zimmer@intel.com -mike.wu@intel.com=20 -shifeix.a.lu@intel.com +## MAINTAINERS + +* david.wei@intel.com +* mang.guo@intel.com +* vincent.zimmer@intel.com +* mike.wu@intel.com +* shifeix.a.lu@intel.com \ No newline at end of file --=20 2.11.0.windows.1 _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel