-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add READMEs for new directory structure
Signed-off-by: Gary O'Neall <[email protected]>
- Loading branch information
Showing
8 changed files
with
43 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Examples form SPDX Presentations | ||
|
||
This directory contains examples from the following presentations: | ||
|
||
* The OSSSumit2023 directory contains the SPDX JSON files used in the SBOM Primary presentation [An SBOM Primer: From Licenses to Security, Know What’s in Your Code, or Someone Else’s!](https://ossna2023.sched.com/event/1KtE8/an-sbom-primer-from-licenses-to-security-know-whats-in-your-code-or-someone-elses-jeff-shapiro-the-linux-foundation-gary-oneall-source-auditor) at the Open Source Summit North America 2023. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# SPDX Software Usage Examples | ||
|
||
This repository includes demonstrations of [SPDX documents](https://spdx.dev) for various examples of software combinations. | ||
|
||
The examples include source code and built / packaged binaries for a variety of scenarios. The software in the repository is (for the most part) not taken from real projects. However, the examples are intended to be demonstrations of how SPDX can convey software bill of materials (SBOM) information for a variety of real-world scenarios. | ||
|
||
## Format of examples | ||
|
||
Directories of the form `example#` are structured as follows: | ||
|
||
- `content/src/`: contains the example's source code | ||
- `content/build/`: contains the example's built artifacts | ||
- `spdx/`: contains one or more SPDX documents (in tag-value or JSON format) for the sources and the build artifacts | ||
- `README.md`: more details about the particular example | ||
|
||
Each directory contains build metadata which is used to create the build artifacts. It assumes that the necessary tools (make, gcc, etc.) are present on your system, and doesn't do any autoconfiguration or the like. | ||
|
||
## Examples | ||
|
||
| # | Sources | Binaries | SPDX | Comments | | ||
|----|---------|----------|------|----------| | ||
| 1 | 1 C file | compiled with gcc | 1 document | source and binary treated as one package | | ||
| 2 | 1 C file | compiled with gcc | 2 documents | source and binary in separate packages | | ||
| 3 | 2 C files | compiled with gcc | 2 documents | shared library, dynamically linked at runtime | | ||
| 4 | 2 C files | compiled with gcc | 2 documents | shared library, dynamically linked at runtime, including system libs | | ||
| 5 | 1 Go file | compiled with go | 2 documents | source and binary in separate packages | | ||
| 6 | 1 Go file | compiled with go | 3 documents | source and binary in separate packages, separate doc for standard libs | | ||
| 7 | 1 Go file | compiled with go | 4 documents | JSON SPDX doc; source and binary in separate packages, separate docs for go tools and third-party module; thank you @nishakm! | | ||
| 8 | 2 Java files | generated from Maven | 1 document | Simple Maven Java project with a minimal set of dependencies | | ||
| 9 | 2 Java files | generated from Gradle | 1 document |a copy of the [App-BOM-ination SPDX example](https://github.com/yevster/App-BOM-ination) contributed by @yevster for the SPDX spec version 2.0 docfest | | ||
| 10 | 1 Python file | python package | 1 document | packaged using the [instructions from python.org](https://packaging.python.org/en/latest/tutorials/packaging-projects/) | | ||
| 11 | 1 Rust file | compiled with Cargo | 1 document | SBOM describing both source and artifact, related with GENERATED_FROM | | ||
|