BCT v3.3.1 release.

README.md

@@ -1,11 +1,27 @@
 # BCT
-Binary Configuration Tool for Intel(R) FSP
+Intel® Binary Configuration Tool for Intel® FSP
 
+## Overview
+
+Intel® Binary Configuration Tool (BCT) is a utility used to change configuration settings embedded in an Intel® FSP binary. One may use BCT to customize the static UPD configuration parameters as described by the [Intel® FSP External Architecture Specification](https://www.intel.com/fsp). BCT cannot configure dynamic UPD parameters.
+
+## Supported Operating Systems
+
+BCT binaries are available for multiple operating systems. Refer to the following table for OS binary compatibility:
+
+Binary Name | Architecture | Testing Operating Systems
+:---------- | :----------: | :------------------------
+[BCT-3.4.0-Windows-Installer.exe](https://github.com/IntelFsp/BCT/blob/master/BCT-3.4.0-Windows-Installer.exe) | IA-32 or X64 | <ul><li>Windows 7</li><li>Windows 8.1</li><li>Windows 10</li></ul>
+[bct-3.4.0-x86_64.ubuntu16.04.tar.gz](https://github.com/IntelFsp/BCT/blob/master/bct-3.4.0-x86_64.ubuntu16.04.tar.gz) | X64 | <ul><li>Ubuntu 18.04 LTS</li><li>Ubuntu 16.04 LTS</li><li>Ubuntu 14.04 LTS</li><li>Debian 9.6 Stretch</li></ul>
+[bct-3.4.0-i686.ubuntu16.04.tar.gz](https://github.com/IntelFsp/BCT/blob/master/bct-3.4.0-i686.ubuntu16.04.tar.gz) | IA-32 | <ul><li>Ubuntu 16.04 LTS</li><li>Ubuntu 14.04 LTS</li></ul>
+[bct-3.4.0-x86_64.fc29.tar.gz](https://github.com/IntelFsp/BCT/blob/master/bct-3.4.0-x86_64.fc29.tar.gz) | X64 | <ul><li>Fedora Workstation 29</li></ul>
+
+## Releases
 
 Project Name | Version | Git command
 :----------- | :-----: | :----------
+Binary Configuration Tool | v3.4.0 | git clone https://github.com/IntelFsp/BCT.git <br /> git checkout BCT_v3_4_0
 Binary Configuration Tool | v3.3.1 | git clone https://github.com/IntelFsp/BCT.git <br /> git checkout BCT_v3_3_1
 Binary Configuration Tool | v3.3.0 | git clone https://github.com/IntelFsp/BCT.git <br /> git checkout BCT_v3_3_0
 Binary Configuration Tool | v3.2.2 | git clone https://github.com/IntelFsp/BCT.git <br /> git checkout BCT_v3_2_2
 Binary Configuration Tool | v3.2.0 | git clone https://github.com/IntelFsp/BCT.git <br /> git checkout BCT_v3_2_0_
-

release-notes.txt

@@ -2,21 +2,21 @@
 Intel(R) Binary Configuration Tool (BCT) Release Notes
 ===============================================================================
 
- Copyright (c) 1999-2013 Intel Corporation All Rights Reserved.
+ Copyright (c) 1999-2018 Intel Corporation All Rights Reserved.
 
- The source code contained or described herein and all documents related to 
+ The source code contained or described herein and all documents related to
  the source code ("Material") are owned by Intel Corporation or its suppliers
  or licensors. Title to the Material remains with Intel Corporation or its
- suppliers and licensors. The Material may contain trade secrets and 
- proprietary and confidential information of Intel Corporation and its 
+ suppliers and licensors. The Material may contain trade secrets and
+ proprietary and confidential information of Intel Corporation and its
  suppliers and licensors, and is protected by worldwide copyright and trade
  secret laws and treaty provisions. No part of the Material may be used,
  copied, reproduced, modified, published, uploaded, posted, transmitted,
- distributed, or disclosed in any way without Intel�s prior express written
+ distributed, or disclosed in any way without Intel's prior express written
  permission.
 
  No license under any patent, copyright, trade secret or other intellectual
- property right is granted to or conferred upon you by disclosure or 
+ property right is granted to or conferred upon you by disclosure or
  delivery of the Materials, either expressly, by implication, inducement,
  estoppel or otherwise. Any license under such intellectual property rights
  must be express and approved by Intel in writing.
@@ -25,15 +25,15 @@ Intel(R) Binary Configuration Tool (BCT) Release Notes
  this notice or any other notice embedded in Materials by Intel or Intel's
  suppliers or licensors in any way.
 
- Except as expressly provided in Intel�s standard license terms and
+ Except as expressly provided in Intel's standard license terms and
  conditions for the Intel software product or in the Intel software
  license agreement accompanying the Intel software product, the Intel
- software product is provided �as is�, without warranty of any kind,
+ software product is provided "as is", without warranty of any kind,
  whether express, implied or statutory, including but not limited to a
  warranty of merchantability, non-infringement of intellectual property,
  or fitness for any particular purpose.
 
- This document is provided �as is� without any express, implied, or
+ This document is provided "as is" without any express, implied, or
  statutory warranty of any kind including but not limited to warranties
  of merchantability, noninfringement of intellectual property, or fitness
  for any particular purpose.  Intel does not warrant or assume responsibility
@@ -58,7 +58,7 @@ CONTENTS
 ===============================================================================
 1.  OVERVIEW
 ===============================================================================
-This Intel(R) Binary Configuration Tool (Intel(R) BCT) is provided as a 
+This Intel(R) Binary Configuration Tool (Intel(R) BCT) is provided as a
 companion tool with the Intel(R) Firmware Support Package and is intended to be
 used to
 
@@ -71,22 +71,29 @@ This tool supports the BSF Specification 4.4a
 ===============================================================================
 2.  RELEASE INFORMATION
 ===============================================================================
-This is the 3.3.1 release of the Intel(R) Binary Configuration Tool and the
+This is the 3.4.0 release of the Intel(R) Binary Configuration Tool and the
 release package includes
-
- - Fedora 24 32-bit executable binary
- - Fedora 24 64-bit executable binary
- - Windows 7 32-bit binary (also executable on Windows 7 64-bit)
+
+ - Ubuntu 14.04/16.04 LTS 32-bit executable binary (18.04 LTS is 64-bit only)
+ - Ubuntu 14.04/16.04/18.04 LTS 64-bit executable binary (also executable on Debian 9.6 Stretch)
+ - Fedora 29 64-bit executable binary
+ - Windows 7/8/10 32-bit binary (also executable on Windows 7/8/10 64-bit)
  - User's Guide
 
- Release 3.3.1
+Release 3.4.0
+=============
+- Compliant with FSP 2.0 spec
+- Compatible with new operating systems
+
+Release 3.3.1
 =============
-- Fixed the byte0 inadvertently change while patching.
-
+- Compliant with FSP 2.0 spec
+- Fixes a bug where byte 0 in the FSP component is inadvertently changed while patching.
+
 Release 3.3.0
 =============
 - Compliant with FSP 2.0 spec
-- Minor updates regarding the Binary file permissions and patching of the Platform specific data.
+- Minor updates regarding the Binary file permissions and patching of the Platform   specific data.
 
 Release 3.2.2
 =============
@@ -106,30 +113,30 @@ Release 3.2.0
 Release 3.1.3
 =============
  - Minor updates
- 
+
 Release 3.1.2
 =============
  - Improved Error handling
- - BCT now searches the VPD and UPD regions of FSP binaries for the signature 
+ - BCT now searches the VPD and UPD regions of FSP binaries for the signature
    specified by the "Find" instruction in the StructDef section
  - BCT now displays the contents of the FSP Header in the binary description
- 
+
 Release 3.1.1
 =============
  - Fixes bug that had disabled using multiple "Find" statements in the StructDef
    section of BSF for FSP binaries. Multiple "Find" statements now function.
  - Fixes bug that crashed BCT when trying to open a malformed BSF.
- - You can now specify an output binary with a file extension other than .rom. 
- 
+ - You can now specify an output binary with a file extension other than .rom.
+
 Release 3.1.0
 =============
- - New! Improved the task of opening a BSF file. You are no longer forced to 
+ - New! Improved the task of opening a BSF file. You are no longer forced to
    click through two wizard panes just to open a file
  - New! BCT now keeps track of the last 5 files you opened in the File pull-
    down menu. Quickly access the files you've been working on most recently
  - New! Show the plain-text description table inside a FSP if it has one
  - New! The command-line interface is now complete. Skip the GUI completely.
-   Use the command line to generate an ABSF, rebase the load address of a 
+   Use the command line to generate an ABSF, rebase the load address of a
    binary, patch a binary with a BSF or ABSF with the option to relocate at the
    same time, print a binary's load address, and print the description table
    You can even specify what BSF you want to open in the GUI on the command line
@@ -140,36 +147,36 @@ Release 3.1.0
    your BSF. Make sure it is defined in the StructDef section of your BSF
  - New! The help pane now displays a more human-readable value for the default
    value of comboboxes
- - New! Improved the initial screen with buttons to quickly access the most 
+ - New! Improved the initial screen with buttons to quickly access the most
    common BCT tasks
- - New! Keyboard shortcuts for patching or rebasing 
+ - New! Keyboard shortcuts for patching or rebasing
  - Removed many seldom-used or unnecessary components
  - The Windows installer now defaults to install in C:\Program Files(x86)\BCT
-   
-   
-Release 3.0.2 
+
+
+Release 3.0.2
 =============
 
 * This is the initial release for BCT
 
 ===============================================================================
 3.  INSTALLATION INFORMATION
 ===============================================================================
-Please refer the Intel(R) Binary Configuration Tool User's Guide for the 
+Please refer the Intel(R) Binary Configuration Tool User's Guide for the
 installation instructions and for help on how to use the tool.
 
 ===============================================================================
-4. LIMITATIONS 
+4. LIMITATIONS
 ===============================================================================
  - The Windows version of BCT will not print messages to the console. This only
    affects Windows users who want to run BCT from the command line and not use
-   the GUI. BCT will read the command line arguments correctly and do things 
+   the GUI. BCT will read the command line arguments correctly and do things
    such as generate an ABSF from a BSF, patch, and rebase a binary, but it will
-   not print any messages to the console. This is a limitation from the tool we 
+   not print any messages to the console. This is a limitation from the tool we
    use to generate a Windows executable.
 
 ===============================================================================
-5. KNOWN ISSUES 
+5. KNOWN ISSUES
 ===============================================================================
  - Rebase.log file is not being generated.