X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=Readme.md;h=594f16b20756ab78987fef4feac2e439743d5b4a;hp=7c873759a504686bd5c5394f1c6eedbab11aa257;hb=582b6cdd08e2f91e5a92acf9c63837b6ed8774e8;hpb=9c6180fb3d4a3f34a19adc41b275e422fcbb083d
diff --git a/Readme.md b/Readme.md
index 7c873759a5..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
+
+
+
+ | Host Type |
+ Toolchain |
+ Branch |
+ Build Status |
+ Test Status |
+ Code Coverage |
+
+
+ | Windows |
+ VS2019 |
+ master |
+
+
+ 
+ |
+
+
+ 
+ |
+
+
+ 
+ |
+
+
+ | Ubuntu |
+ GCC |
+ master |
+
+
+ 
+ |
+
+
+ 
+ |
+
+
+
+ |
+
+
+
+[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:
@@ -140,3 +191,42 @@ Signed-off-by: Contributor Name
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.