Skip to content

docs: enhance introduction in README.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 5, 2025
Merged

docs: enhance introduction in README.md #5

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98cdc35
docs: enhance introduction in README.md
leoreinmann May 23, 2025
2497875
docs(README): minor changes in the wording
hakandilek Jun 4, 2025
8d0476e
fix(lint): update to mypy's stricter type checking
leoreinmann Jun 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@
A Python library for creating and consuming documents in
[standard-bom format](https://sbom.siemens.io/latest/format.html).

This library is mainly a wrapper for the official
[cyclonedx-python-lib](https://github.com/CycloneDX/cyclonedx-python-lib/) library.
"Standard BOM" is our Siemens-internal SBOM format based on the [Siemens CycloneDX Property Taxonomy](https://github.com/siemens/cyclonedx-property-taxonomy), which is 100% compatible with the CycloneDX.

Every Standard BOM document is a 100% CycloneDX document, so both CycloneDX and Standard BOM formats are supported both
for reading and writing SBOMs with this library.

## Installation

Expand Down Expand Up @@ -120,8 +122,8 @@ component.licenses = licenses

In order to build this library on your local PC, and/or contribute to this library, mind the following prerequisites:

- [Python](https://www.python.org/doc/versions/) > v3.10 - ideally > v3.12
- [Poetry](https://python-poetry.org/) > v1.8.0
- [Python](https://www.python.org/doc/versions/) >=3.10, <4.0
- [Poetry](https://python-poetry.org/) >= v2.0

---
Once you have those prerequisites you can perform following development tasks locally:
Expand Down
Loading