summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Kinney <michael.d.kinney@intel.com>2016-10-14 00:05:28 -0700
committerMichael Kinney <michael.d.kinney@intel.com>2016-10-14 00:05:28 -0700
commitb5e3f3e4e3ee02270c4068297c1c3d17bb91c6e9 (patch)
tree7c0b73156b84f6ff5fdb3828236731468473ee26
parent6a7b914b48d81b6c98b41a6fde9c5d6a391414bb (diff)
downloadedk2-platforms-about.tar.xz
Fix spelling errors and typos.about
Update based on feedback from Leif Lindholm Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Michael Kinney <michael.d.kinney@intel.com>
-rw-r--r--Readme.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/Readme.md b/Readme.md
index b51fed4163..87d1a358e1 100644
--- a/Readme.md
+++ b/Readme.md
@@ -12,7 +12,6 @@ EDK II community. This serves several purposes:
choose to help finish and validate
* Allow more platforms to be used as part of the edk2 validation and
release cycle.
-* Not intended to be used for bug fixes.
# Process for creating, using, and maintaining platforms
1. Create a new repo called edk2-platforms
@@ -38,21 +37,21 @@ EDK II community. This serves several purposes:
1. Maintainer sends patch email to edk2-devel mailing list
announcing the creation of a new branch in edk2-platforms
- with Readme.MD. Readme.MD must be in root of branch with
+ with Readme.md. Readme.md must be in root of branch with
summary, owners, status, build instructions, target update
instructions, OS compatibility, known issues/limitations,
links to related materials, and anything else a developer
needs to use platform(s) in that branch.
- 2. Readme.MD must provide the PACKAGES_PATH setting required to
+ 2. Readme.md must provide the PACKAGES_PATH setting required to
build along with the branch names of other repos that platform
requires. This allows a platform developer(s) to use packages
- from edk2/master or to use packages from a validates UDK release
+ from edk2/master or to use packages from a validated UDK release
(e.g. edk2/UDK2015).
- 3. Maintainer creates branch with Readme.MD in edk2-platforms
+ 3. Maintainer creates branch with Readme.md in edk2-platforms
- 4. An edk2-platforms branch for platforms under developer use the
+ 4. An edk2-platforms branch for platforms under development use the
following branch naming convention:
`edk2-platforms/devel-*`
@@ -66,7 +65,7 @@ EDK II community. This serves several purposes:
1. Commit message subject format:
- `[platforms/branch PATCH]: Package/Module: Subject`
+ `[PATCH][platforms/branch]: Package/Module: Subject`
2. Directly commit changes to branch or if community review is desired,
use edk2-devel review process.
@@ -89,14 +88,14 @@ EDK II community. This serves several purposes:
1. Clone edk2-platforms/[branch name]
- 2. Following instructions in Readme.MD to build firmware and
+ 2. Following instructions in Readme.md to build firmware and
update target platform
# Multiple Platform Template
-This section is a template for a Readme.MD in an edk2-platforms branch
-that support multiple platforms. The list of platforms is presented here
-with links to the Readme.MD in each platform subdirectory
+This section is a template for a Readme.md file in an edk2-platforms branch
+that supports multiple platforms. The list of platforms is presented here
+with links to the Readme.md in each platform subdirectory.
* [Sample Platform](SamplePlatformPkg/Readme.md)
* [Another Platform](AnotherPlatformPkg/Readme.md)