Skip to content
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.

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

Include FSCT3 information in README #226

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Include FSCT3 information in README #226

wants to merge 3 commits into from

Conversation

bact
Copy link
Contributor

@bact bact commented Nov 28, 2024

  • Add information about Framing Software Component Transparency (FSCT) and its experimental support
  • Update command line usage and examples
    • Use sbomcheck in the examples
    • Add option --comply
  • Update Python code example, to use a property that is not specific to NTIA only
  • Also fix Markdown warnings
    • The use of both - and * for list (fixed to use only -)
    • The doc should started with H1 heading (fixed by moving badges to show just immediately under the title heading)
    • The doc should have only one H1 heading (fixed by making others to H2)

To should only get merged after PR #224 is sorted.

A review is also requested to look at the use of these words:
"comply", "compliance", "conformance", "standard", "document", "specification"
as I am not sure about the preference and the specific/different meaning that they may have within the project.

- Add information about Framing Software Component Transparency (FSCT) and its experimental support
- Update command line usage and examples
  - Use `sbomcheck` in the examples
  - Add option `--comply`
- Also fix Markdown warnings
  - The use of both `-` and `*` for list (fixed to use only `-`)
  - The doc should started with H1 heading (fixed by moving badges to show just immediately under the title heading)
  - The doc should have only one H1 heading (fixed by making others to H2)

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant