X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=Readme.md;h=594f16b20756ab78987fef4feac2e439743d5b4a;hb=61d3b2d4279e1951c3afee5a8de9e7f9b6ff9ecc;hp=e564c6c09b83649e1f3ab66bf0fb220fd5022a97;hpb=b8993a34ae0069080138536249dc6a72bbd7b696;p=mirror_edk2.git

diff --git a/Readme.md b/Readme.md
index e564c6c09b..594f16b207 100644
--- a/Readme.md
+++ b/Readme.md
@@ -3,6 +3,57 @@
 A modern, feature-rich, cross-platform firmware development environment
 for the UEFI and PI specifications from www.uefi.org.
 
+# Build Status
+
+<table>
+  <tr>
+    <th>Host Type</th>
+    <th>Toolchain</th>
+    <th>Branch</th>
+    <th>Build Status</th>
+    <th>Test Status</th>
+    <th>Code Coverage</th>
+  </tr>
+  <tr>
+    <td>Windows</td>
+    <td>VS2019</td>
+    <td>master</td>
+    <td>
+      <a  href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master">
+      <img src="https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/Windows%20VS2019%20CI?branchName=master"/></a>
+    </td>
+    <td>
+      <a  href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master">
+      <img src="https://img.shields.io/azure-devops/tests/tianocore/edk2-ci/32.svg"/></a>
+    </td>
+    <td>
+      <a  href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=32&branchName=master">
+      <img src="https://img.shields.io/badge/coverage-coming_soon-blue"/></a>
+    </td>
+  </tr>
+  <tr>
+    <td>Ubuntu</td>
+    <td>GCC</td>
+    <td>master</td>
+    <td>
+      <a  href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master">
+      <img src="https://dev.azure.com/tianocore/edk2-ci/_apis/build/status/Ubuntu%20GCC5%20CI?branchName=master"/></a>
+    </td>
+    <td>
+      <a  href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master">
+      <img src="https://img.shields.io/azure-devops/tests/tianocore/edk2-ci/31.svg"/></a>
+    </td>
+    <td>
+      <a  href="https://dev.azure.com/tianocore/edk2-ci/_build/latest?definitionId=31&branchName=master">
+      <img src="https://img.shields.io/badge/coverage-coming_soon-blue"/></a>
+    </td>
+  </tr>
+</table>
+
+[More CI Build information](.pytool/Readme.md)
+
+# License Details
+
 The majority of the content in the EDK II open source project uses a
 [BSD-2-Clause Plus Patent License](License.txt).  The EDK II open source project
 contains the following components that are covered by additional licenses:
@@ -28,9 +79,6 @@ are listed in [Maintainers.txt](Maintainers.txt).
 * [TianoCore Bugzilla](https://bugzilla.tianocore.org)
 * [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute)
 * [Release Planning](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Release-Planning)
-* [UDK2017](https://github.com/tianocore/edk2/releases/tag/vUDK2017)
-* [UDK2018](https://github.com/tianocore/edk2/releases/tag/vUDK2018)
-* [edk2-stable201811](https://github.com/tianocore/edk2/releases/tag/edk2-stable201811)
 
 # Code Contributions
 To make a contribution to a TianoCore project, follow these steps.
@@ -143,3 +191,42 @@ Signed-off-by: Contributor Name <contributor@example.com>
   the change.  Each line should be less than ~70 characters.
 * `Signed-off-by` is the contributor's signature identifying them
   by their real/legal name and their email address.
+
+# Submodules
+
+Submodule in EDK II is allowed but submodule chain should be avoided
+as possible as we can. Currently EDK II contains the following submodules
+
+- CryptoPkg/Library/OpensslLib/openssl
+- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3
+
+ArmSoftFloatLib is actually required by OpensslLib. It's inevitable
+in openssl-1.1.1 (since stable201905) for floating point parameter
+conversion, but should be dropped once there's no such need in future
+release of openssl.
+
+To get a full, buildable EDK II repository, use following steps of git
+command
+
+```
+$ git clone https://github.com/tianocore/edk2.git
+$ cd edk2
+$ git submodule update --init
+$ cd ..
+```
+
+If there's update for submodules, use following git commands to get the
+latest submodules code.
+
+```
+$ cd edk2
+$ git pull
+$ git submodule update
+```
+
+Note: When cloning submodule repos, '--recursive' option is not
+recommended. EDK II itself will not use any code/feature from
+submodules in above submodules. So using '--recursive' adds a
+dependency on being able to reach servers we do not actually want
+any code from, as well as needlessly downloading code we will not
+use.