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.

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

Jump to bottom

updated README to reflect the new file names and structures #66

Merged
merged 2 commits into from
Sep 9, 2022
Merged

updated README to reflect the new file names and structures #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9db8992
updated README to reflect the new file names and structures
Sep 9, 2022
b45b6de
updated CompareDocs method name in README
Sep 9, 2022
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The SPDX Tool binaries can be downloaded from the [releases page](https://github

See the Syntax section below for the commands available.

If are a developer, there are examples in the [examples folder](examples/org/spdx/examples).
If you are a developer, there are examples in the [examples folder](examples/org/spdx/examples).

## Contributing
See the file CONTRIBUTING.md for information on making contributions to the SPDX tools.
Expand All @@ -30,7 +30,7 @@ Non-security related issues should be added to the [SPDX tools issues list](http
## Syntax
The command line interface of the spdx tools can be used like this:

java -jar spdx-tools-jar-with-dependencies.jar <function> <parameters>
java -jar tools-java-1.1.0-jar-with-dependencies.jar <function> <parameters>

## SPDX format converters
The following converter tools support spdx format:
Expand All @@ -45,7 +45,7 @@ The following converter tools support spdx format:

Example to convert a SPDX file from tag to rdf format:

java -jar spdx-tools-jar-with-dependencies.jar Convert Examples/SPDXTagExample.tag TagToRDF.rdf
java -jar tools-java-1.1.0-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.rdf

## Compare utilities
The following tools can be used to compare one or more SPDX documents:
Expand All @@ -54,13 +54,13 @@ The following tools can be used to compare one or more SPDX documents:

Example to compare multiple SPDX files provided in rdf format and provide a spreadsheet with the results:

java -jar spdx-tools-jar-with-dependencies.jar CompareMultipleSpdxDocs output.xlsx doc1 doc2 ... docN
java -jar tools-java-1.1.0-jar-with-dependencies.jar CompareDocs output.xlsx doc1 doc2 ... docN

* CompareMultipleSpdxDocs with directory

Example to compare all SPDX documents in a directory "/home/me/spdxdocs" and provide a spreadsheet with the results:

java -jar spdx-tools-jar-with-dependencies.jar CompareMultipleSpdxDocs output.xlsx /home/me/spdxdocs
java -jar tools-java-1.1.0-jar-with-dependencies.jar CompareDocs output.xlsx /home/me/spdxdocs

## SPDX Viewer
The following tool can be used to "Pretty Print" an SPDX document.
Expand All @@ -69,7 +69,7 @@ The following tool can be used to "Pretty Print" an SPDX document.

Sample usage:

java -jar spdx-tools-jar-with-dependencies.jar SPDXViewer TestFiles/SPDXRdfExample.rdf
java -jar tools-java-1.1.0-jar-with-dependencies.jar SPDXViewer ../testResources/SPDXRdfExample-v2.2.spdx.rdf

## Verifier
The following tool can be used to verify an SPDX document:
Expand All @@ -78,7 +78,7 @@ The following tool can be used to verify an SPDX document:

Sample usage:

java -jar spdx-tools-jar-with-dependencies.jar Verify TestFiles/SPDXRdfExample.rdf
java -jar tools-java-1.1.0-jar-with-dependencies.jar Verify ../testResources/SPDXRdfExample-v2.2.spdx.rdf

## Generators
The following tool can be used to generate an SPDX verification code from a directory of source files:
Expand All @@ -87,7 +87,7 @@ The following tool can be used to generate an SPDX verification code from a dire

Sample usage:

java -jar spdx-tools-jar-with-dependencies.jar GenerateVerificationCode sourceDirectory [ignoredFilesRegex]
java -jar tools-java-1.1.0-jar-with-dependencies.jar GenerateVerificationCode sourceDirectory [ignoredFilesRegex]

## SPDX Validation Tool
The SPDX Workgroup provides an online interface to validate, compare, and convert SPDX documents in addition to the command line options above. The [SPDX Validation Tool](https://tools.spdx.org/app/validate/) is an all-in-one portal to upload and parse SPDX documents for validation, comparison and conversion and search the SPDX license list.
Expand Down