public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: Michael D Kinney <michael.d.kinney@intel.com>
To: edk2-devel@lists.01.org
Cc: Leif Lindholm <leif.lindholm@linaro.org>,
	Andrew Fish <afish@apple.com>,
	Jordan Justen <jordan.l.justen@intel.com>
Subject: [Patch V3 8/8] edk2: Add Readme.md to root of edk2 repository
Date: Wed, 19 Jul 2017 22:44:11 -0700	[thread overview]
Message-ID: <20170720054411.18928-9-michael.d.kinney@intel.com> (raw)
In-Reply-To: <20170720054411.18928-1-michael.d.kinney@intel.com>

https://bugzilla.tianocore.org/show_bug.cgi?id=643

Add Readme.md with a brief description of the EDK II
open source project along with links to contribution
agreement, licenses, and resources.  It also provides
the Change Description / Commit Message / Patch Email
details that were moved out of the Contributions.txt
file.

Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Andrew Fish <afish@apple.com>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
---
 Readme.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000000..a50a7df5c1
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,72 @@
+# EDK II Project
+
+A modern, feature-rich, cross-platform firmware development environment
+for the UEFI and PI specifications from www.uefi.org.
+
+Contributions to the EDK II open source project are covered by the 
+[TianoCore Contribution Agreement 1.1](Contributions.txt)
+
+The majority of the content in the EDK II open source project uses a
+[BSD 2-Clause License](LICENSE).  The EDK II open source project contains
+the following components that are covered by additional licenses:
+* [AppPkg/Applications/Python/Python-2.7.2/Tools/pybench](AppPkg/Applications/Python/Python-2.7.2/Tools/pybench/LICENSE)
+* [AppPkg/Applications/Python/Python-2.7.2](AppPkg/Applications/Python/Python-2.7.2/LICENSE)
+* [AppPkg/Applications/Python/Python-2.7.10](AppPkg/Applications/Python/Python-2.7.10/LICENSE)
+* [BaseTools/Source/C/BrotliCompress](BaseTools/Source/C/BrotliCompress/LICENSE)
+* [MdeModulePkg/Library/BrotliCustomDecompressLib](MdeModulePkg/Library/BrotliCustomDecompressLib/LICENSE)
+* [OvmfPkg/Include/IndustryStandard/Xen](OvmfPkg/License.txt)
+* [OvmfPkg/XenBusDxe](OvmfPkg/License.txt)
+* [OvmfPkg/XenPvBlkDxe](OvmfPkg/License.txt)
+* [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library/OpensslLib/openssl/LICENSE)
+
+# Resources
+* [TianoCore](http://www.tianocore.org)
+* [EDK II](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II)
+* [Getting Started with EDK II](https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II)
+* [Mailing Lists](https://github.com/tianocore/tianocore.github.io/wiki/Mailing-Lists)
+* [TianoCore Bugzilla](https://bugzilla.tianocore.org)
+* [How To Contribute](https://github.com/tianocore/tianocore.github.io/wiki/How-To-Contribute)
+
+# Change Description / Commit Message / Patch Email
+
+Your change description should use the standard format for a
+commit message, and must include your `Signed-off-by` signature
+and the `Contributed-under` message.
+
+## Sample Change Description / Commit Message
+
+```
+From: Contributor Name <contributor@example.com>
+Subject: [PATCH] CodeModule: Brief-single-line-summary
+
+Full-commit-message
+
+Contributed-under: TianoCore Contribution Agreement 1.0
+Signed-off-by: Contributor Name <contributor@example.com>
+---
+
+An extra message for the patch email which will not be considered part
+of the commit message can be added here.
+
+Patch content inline or attached
+```
+## Notes for sample patch email
+
+* The first line of commit message is taken from the email's subject
+  line following `[PATCH]`. The remaining portion of the commit message
+  is the email's content until the `---` line.
+* git format-patch is one way to create this format
+
+## Definitions for sample patch email
+
+* **`CodeModule`** - a short idenfier for the affected code.  For
+  example `MdePkg`, or `MdeModulePkg/UsbBusDxe`.
+* **`Brief-single-line-summary`** - a short summary of the change.
+  The entire first line should be less than ~70 characters.
+* **`Full-commit-message`** - a verbose multiple line comment describing
+  the change.  Each line should be less than ~70 characters.
+* **`Contributed-under`** - explicitely states that the contribution is
+  made under the terms of the contribtion agreement.  This
+  agreement is included below in this document.
+* **`Signed-off-by`** - the contributor's signature identifying them
+  by their real/legal name and their email address.
-- 
2.13.1.windows.2



      parent reply	other threads:[~2017-07-20  5:42 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-20  5:44 [Patch V3 0/8] Update to Tiano Contribution Agreement 1.1 Michael D Kinney
2017-07-20  5:44 ` [Patch V3 1/8] BaseTools/PatchCheck: Support " Michael D Kinney
2017-07-20 22:57   ` Jordan Justen
2017-07-20  5:44 ` [Patch V3 2/8] edk2: Move TianoCore Contribution Agreement to root Michael D Kinney
2017-07-20  5:44 ` [Patch V3 3/8] edk2: Remove commit message details from Contributions.txt Michael D Kinney
2017-07-21 21:16   ` Jordan Justen
2017-07-21 22:14     ` Leif Lindholm
2017-07-24 18:13       ` Kinney, Michael D
2017-07-24 19:33         ` Jordan Justen
2017-07-24 20:01           ` Kinney, Michael D
2017-07-24 20:46             ` Jordan Justen
2017-07-20  5:44 ` [Patch V3 4/8] edk2: Update to TianoCore Contribution Agreement 1.1 Michael D Kinney
2017-07-20  5:44 ` [Patch V3 5/8] edk2: Reformat " Michael D Kinney
2017-07-20  5:44 ` [Patch V3 6/8] edk2/OvmfPkg: Add MIT license files Michael D Kinney
2017-07-20  5:44 ` [Patch V3 7/8] edk2: Move License.txt file to root Michael D Kinney
2017-07-20  6:35   ` Jordan Justen
2017-07-20 15:09     ` Kinney, Michael D
2017-07-20 22:53       ` Jordan Justen
2017-07-20 23:39         ` Kinney, Michael D
2017-07-25 10:06           ` Laszlo Ersek
2017-07-20  5:44 ` Michael D Kinney [this message]

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=20170720054411.18928-9-michael.d.kinney@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