public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Agyeman, Prince" <prince.agyeman@intel.com>
To: devel@edk2.groups.io
Cc: Michael Kubacki <michael.a.kubacki@intel.com>,
	Michael D Kinney <michael.d.kinney@intel.com>,
	Nate DeSimone <nathaniel.l.desimone@intel.com>,
	Liming Gao <liming.gao@intel.com>,
	Ankit Sinha <ankit.sinha@intel.com>,
	Bowen Zhou <bowen.zhou@intel.com>,
	Shifei A Lu <shifei.a.lu@intel.com>
Subject: [edk2-platforms/devel-MinPlatform] [PATCH v2 2/3] ReadMe.md: Update the build instructions
Date: Wed, 17 Apr 2019 15:55:47 -0700	[thread overview]
Message-ID: <0e7341094bb9f54a83d0381daae19a33aaa07e83.1555538295.git.prince.agyeman@intel.com> (raw)
In-Reply-To: <cover.1555538295.git.prince.agyeman@intel.com>

Updated the build instructions to include
the python script build instructions

Cc: Michael Kubacki <michael.a.kubacki@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Cc: Bowen Zhou<bowen.zhou@intel.com>
Cc: Shifei A Lu <shifei.a.lu@intel.com>

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Agyeman <prince.agyeman@intel.com>
---
 ReadMe.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/ReadMe.md b/ReadMe.md
index 72e332a476..a94d8051d6 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -105,6 +105,43 @@ return back to the minimum platform caller.
 
 ### Build
 
+**Building with the python script**
+
+1. Open command window, go to the workspace directory, e.g. c:\Kabylake.
+2. Type "cd edk2-platforms\Platform\Intel
+3. Type "python BuildBios.py -p REPLACE_WITH_BOARD_NAME"
+
+* BuildBios.py Arguments:
+
+  | Argument              | Function                            |
+  | ----------------------|-------------------------------------|
+  | -h, --help            | Show this help message and exit     |
+  | --platform, -p        | The platform to build               |
+  | --toolchain, -t       | Tool Chain to use in build process  |
+  | --DEBUG, -d           | Debug flag                          |
+  | --RELEASE, -r         | Release flag                        |
+  | --TEST_RELEASE, -tr   | Test Release flag                   |
+  | --RELEASE_PDB, -rp    | Release flag                        |
+  | --list, -l            | Lists available platforms           |
+  | --cleanall            | Cleans all                          |
+  | --capsule             | Capsule build enabled               |
+  | --silent              | Silent build enabled                |
+  | --performance         | Performance build enabled           |
+  | --fsp                 | Fsp build enabled                   |
+  |                                                             |
+
+* For more information on build options
+  * ``Type "python BuildBios.py -h"``
+
+* Configuration Files
+  * ``The edk2-platforms\Platform\Intel\Build.json file contains the default settings used by BuildBios.py``
+  * ``The default settings are under the DEFAULT_CONFIG field``
+  * ``Each board can have a settings JSON file that will override the edk2-platforms\Platform\Intel\Build.json settings``
+  * ``An example of a board specific settings:``
+    * ``edk2-platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3\BuildConfig.json``
+
+
+**Building with the batch scripts**
 For KabylakeOpenBoardPkg
 1. Open command window, go to the workspace directory, e.g. c:\Kabylake.
 2. Type "cd edk2-platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3".
-- 
2.19.1.windows.1


  parent reply	other threads:[~2019-04-17 22:55 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-17 22:55 [edk2-platforms/devel-MinPlatform] [PATCH v2 0/3] Added python build scipts to minplaform Agyeman, Prince
2019-04-17 22:55 ` [edk2-platforms/devel-MinPlatform] [PATCH v2 1/3] Platform/Intel: Added python build script Agyeman, Prince
2019-04-20  0:31   ` [edk2-devel] " Nate DeSimone
2019-04-17 22:55 ` Agyeman, Prince [this message]
2019-04-17 22:55 ` [edk2-platforms/devel-MinPlatform] [PATCH v2 3/3] Removing build batch files from ClevoOpenBoardPkg, KabylakeOpenBoardPkg and PurleyOpenBoardPkg Agyeman, Prince

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0e7341094bb9f54a83d0381daae19a33aaa07e83.1555538295.git.prince.agyeman@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox