summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngel Pons <th3fanbus@gmail.com>2020-05-30 15:43:21 +0200
committerAngel Pons <th3fanbus@gmail.com>2020-05-30 15:44:03 +0200
commit1a1ebb82d72f91f40e6dc7604928ffe6a6bbad31 (patch)
tree6fc9c66a90c86df4611c3a61bce1d772185941ca
parentf0f7d5fee730e70165054e6e2b442d9628dc3760 (diff)
downloadblobs-1a1ebb82d72f91f40e6dc7604928ffe6a6bbad31.tar.gz
README.md: Make contents Markdown-friendlier
Change-Id: I7620e1ce43a8e7efaf96b1df0651190dd44bab62 Signed-off-by: Angel Pons <th3fanbus@gmail.com>
-rw-r--r--README.md71
1 files changed, 36 insertions, 35 deletions
diff --git a/README.md b/README.md
index 576548c..ee7d74c 100644
--- a/README.md
+++ b/README.md
@@ -8,53 +8,54 @@ nor completely eliminate binaries, but it can set standards and expectations
for vendor participation. coreboot needs policies and guidelines to meet GPL
licence requirements and to organize and maintain standards within coreboot.
-
To accept binaries in coreboot 3rdparty/blobs repository, **the binary
must meet the following**:
+## 1. A publicly available (published) ABI
+
+* In case of non-ISA binary, documented usage conventions are required
+* Examples:
-1. A publicly available (published) ABI
- a. In case of non-ISA binary, documented usage conventions are required
- b. examples:
- * The IntelĀ® Firmware Support Package: External Architecture
+ * The IntelĀ® Firmware Support Package: External Architecture
Specification v.1.0
- * The PCI firmware specification is the ABI for a standard PCI video BIOS.
- * Vendor microcode loading and placement instructions
+ * The PCI firmware specification is the ABI for a standard PCI video BIOS.
+ * Vendor microcode loading and placement instructions
+
+## 2. Appropriate license (redistributable)
+The binary must be accompanied by a distribution license. The license
+must allow unlimited redistribution to allow coreboot contributors to
+create coreboot images for third parties which contain this and other blobs.
-2. Appropriate license (redistributable)
- The binary must be accompanied by a distribution license. The license
- must allow unlimited redistribution to allow coreboot contributors to
- create coreboot images for third parties which contain this and other blobs.
+## 3. Linking
+Source code linked into coreboot may not be committed to the binary
+repository. Such source code and header files must be committed to the
+coreboot repository instead.
-3. Linking
- Source code linked into coreboot may not be committed to the binary
- repository. Such source code and header files must be committed to the
- coreboot repository instead.
+## 4. Binary version
+The binary must contain the version and how to extract the version must
+be published in the ABI
-4. Binary version
- The binary must contain the version and how to extract the version must
- be published in the ABI
+## 5. Release notes - updated with each version
+Each binary release must be accompanied by a release note that contains
+all of the following (if a field is unknown or unavailable, mark it as
+unknown or N/A):
-5. Release notes - updated with each version
- Each binary release must be accompanied by a release note that contains
- all of the following (if a field is unknown or unavailable, mark it as
- unknown or N/A):
- * version
- * release date
- * supported silicon
- * instructions, requirements, and dependencies
- * changes since the last version
- * errata, known issues
- * toolchain version(s), if applicable
- * ABI version and link to the published ABI (in the binary repository)
+ * version
+ * release date
+ * supported silicon
+ * instructions, requirements, and dependencies
+ * changes since the last version
+ * errata, known issues
+ * toolchain version(s), if applicable
+ * ABI version and link to the published ABI (in the binary repository)
+## 6. Good commit message
-6. Good commit message
- The commit message should summarize the release note and contain
- any additional information that might be specific to coreboot. It is
- helpful to indicate how the binary was tested within coreboot and list
- any known exceptions or errata.
+The commit message should summarize the release note and contain
+any additional information that might be specific to coreboot. It is
+helpful to indicate how the binary was tested within coreboot and list
+any known exceptions or errata.