Skip to content

Commit 742af94

Browse files
bactgoneall
bact
authored and
goneall
committed
Update JAR name in command line examples to 2.0.0
- Update JAR name in command line examples to version 2.0.0 - Fix few Markdown issues - Add Javadoc link
1 parent 2910e35 commit 742af94

1 file changed

Lines changed: 71 additions & 50 deletions

File tree

‎README.md‎

Lines changed: 71 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,143 @@
1-
# Overview
1+
# SPDX Tools
2+
3+
[![javadoc](https://javadoc.io/badge2/org.spdx/tools-java/javadoc.svg)](https://javadoc.io/doc/org.spdx/tools-java)
4+
5+
A command-line utility for creating, converting, comparing,
6+
and validating SPDX documents across multiple formats.
7+
28
The Software Package Data Exchange (SPDX) specification is a standard format for communicating the components, licenses and copyrights associated with a software package.
39

4-
* [SPDX License List](http://spdx.org/licenses/)
5-
* [SPDX Vocabulary Specification](http://spdx.org/rdf/terms)
10+
* [SPDX License List](https://spdx.org/licenses/)
11+
* [SPDX Vocabulary Specification](https://spdx.org/specifications)
612

7-
These tools are published by the SPDX Workgroup
8-
see [http://spdx.org/](http://spdx.org/)
13+
These tools are published by the SPDX Workgroup,
14+
see <https://spdx.org/>
915

1016
## Versions Supported
17+
1118
This utility supports versions 2.0, 2.1, 2.2, 2.3 and 3.0.1 of the SPDX specification.
1219

13-
# Code quality badges
20+
## Code quality badges
1421

15-
| [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=bugs)](https://sonarcloud.io/dashboard?id=tools-java) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=security_rating)](https://sonarcloud.io/dashboard?id=tools-java) | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=tools-java) | [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=sqale_index)](https://sonarcloud.io/dashboard?id=tools-java) |
22+
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=bugs)](https://sonarcloud.io/dashboard?id=tools-java)
23+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=security_rating)](https://sonarcloud.io/dashboard?id=tools-java)
24+
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=tools-java)
25+
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=tools-java&metric=sqale_index)](https://sonarcloud.io/dashboard?id=tools-java)
1626

1727
## Getting Starting
1828

19-
The SPDX Tool binaries can be downloaded from the [releases page](https://github.com/spdx/tools-java/releases) under the respective release. The package is also available in [Maven Central](https://search.maven.org/artifact/org.spdx/tools-java) (organization org.spdx, artifact tools-java).
29+
The SPDX Tools binaries can be downloaded from the [releases page](https://github.com/spdx/tools-java/releases) under the respective release. The package is also available in [Maven Central](https://search.maven.org/artifact/org.spdx/tools-java) (organization org.spdx, artifact tools-java).
2030

2131
See the Syntax section below for the commands available.
2232

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

25-
## Contributing
26-
See the file CONTRIBUTING.md for information on making contributions to the SPDX tools.
27-
28-
## Issues
29-
Report any security related issues by sending an email to [spdx-tools-security@lists.spdx.org](mailto:spdx-tools-security@lists.spdx.org)
30-
31-
Non-security related issues should be added to the [SPDX tools issues list](https://github.com/spdx/tools-java/issues)
32-
3335
## Syntax
34-
The command line interface of the spdx tools can be used like this:
3536

36-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar <function> <parameters>
37+
The command line interface of the SPDX Tools can be used like this:
38+
39+
java -jar tools-java-2.0.0-jar-with-dependencies.jar <function> <parameters>
3740

3841
## SPDX format converters
39-
The following converter tools support spdx format:
4042

41-
* Tag
42-
* RDF/XML
43-
* XLSX Spreadsheet
44-
* XLS Spreadsheet
45-
* JSON
46-
* XML
47-
* YAML
48-
* JSON-LD (SPDX spec version 3.0.1)
43+
The following converter tools support SPDX format:
4944

50-
Example to convert a SPDX file from tag to rdf format:
45+
* Tag
46+
* RDF/XML
47+
* XLSX Spreadsheet
48+
* XLS Spreadsheet
49+
* JSON
50+
* XML
51+
* YAML
52+
* JSON-LD (SPDX spec version 3.0.1)
5153

52-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.rdf
54+
Example to convert a SPDX file from Tag to RDF format:
55+
56+
java -jar tools-java-2.0.0-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.rdf
5357

5458
The file formats can optionally be provided as the 3rd and 4th parameter for the input and output formats respectively. An optional 5th option `excludeLicenseDetails` will not copy the listed license properties to the output file. The following example will copy a JSON format to an RDF Turtle format without including the listed license properties:
5559

56-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.ttl TAG RDFTTL excludeLicenseDetails
60+
java -jar tools-java-2.0.0-jar-with-dependencies.jar Convert ../testResources/SPDXTagExample-v2.2.spdx TagToRDF.ttl TAG RDFTTL excludeLicenseDetails
5761

5862
To convert from SPDX 2 to SPDX 3.0.1:
63+
5964
* use the file extension `.jsonld.json` or `.jsonld`;
6065
* or add the options for the from and to file types:
61-
```
62-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar Convert hello.spdx hello.spdx.json TAG JSONLD
63-
```
66+
67+
java -jar tools-java-2.0.0-jar-with-dependencies.jar Convert hello.spdx hello.spdx.json TAG JSONLD
6468

6569
## Compare utilities
66-
The following tools can be used to compare one or more SPDX documents:
6770

68-
* CompareMultipleSpdxDocs with files
71+
The following tools can be used to compare one or more SPDX documents:
6972

70-
Example to compare multiple SPDX files provided in rdf format and provide a spreadsheet with the results:
73+
* CompareMultipleSpdxDocs with files
7174

72-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar CompareDocs output.xlsx doc1 doc2 ... docN
75+
Example to compare multiple SPDX files provided in RDF format and provide a spreadsheet with the results:
7376

74-
* CompareMultipleSpdxDocs with directory
77+
java -jar tools-java-2.0.0-jar-with-dependencies.jar CompareDocs output.xlsx doc1 doc2 ... docN
78+
79+
* CompareMultipleSpdxDocs with directory
7580

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

78-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar CompareDocs output.xlsx /home/me/spdxdocs
83+
java -jar tools-java-2.0.0-jar-with-dependencies.jar CompareDocs output.xlsx /home/me/spdxdocs
7984

8085
## SPDX Viewer
86+
8187
The following tool can be used to "Pretty Print" an SPDX document.
8288

83-
* SPDXViewer
89+
* SPDXViewer
8490

8591
Sample usage:
8692

87-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar SPDXViewer ../testResources/SPDXRdfExample-v2.2.spdx.rdf
93+
java -jar tools-java-2.0.0-jar-with-dependencies.jar SPDXViewer ../testResources/SPDXRdfExample-v2.2.spdx.rdf
8894

8995
## Verifier
96+
9097
The following tool can be used to verify an SPDX document:
9198

92-
* Verify
99+
* Verify
93100

94101
Sample usage:
95102

96-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar Verify ../testResources/SPDXRdfExample-v2.2.spdx.rdf
103+
java -jar tools-java-2.0.0-jar-with-dependencies.jar Verify ../testResources/SPDXRdfExample-v2.2.spdx.rdf
97104

98105
## Generators
106+
99107
The following tool can be used to generate an SPDX verification code from a directory of source files:
100108

101-
* GenerateVerificationCode sourceDirectory
109+
* GenerateVerificationCode sourceDirectory
102110

103111
Sample usage:
104112

105-
java -jar tools-java-2.0.0-RC2-jar-with-dependencies.jar GenerateVerificationCode sourceDirectory [ignoredFilesRegex]
113+
java -jar tools-java-2.0.0-jar-with-dependencies.jar GenerateVerificationCode sourceDirectory [ignoredFilesRegex]
106114

107115
## SPDX Validation Tool
116+
108117
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.
109118

110-
# License
119+
## License
120+
111121
A complete SPDX file is available including dependencies is available in the bintray and Maven repos.
112122

113-
SPDX-License-Identifier: Apache-2.0
114-
PackageLicenseDeclared: Apache-2.0
123+
SPDX-License-Identifier: Apache-2.0
124+
PackageLicenseDeclared: Apache-2.0
125+
126+
## Development
115127

116-
# Development
128+
### Build
117129

118-
## Build
119130
You need [Apache Maven](http://maven.apache.org/) to build the project:
120131

121132
mvn clean install
122133

134+
## Contributing
135+
136+
See the file [CONTRIBUTING.md](./CONTRIBUTING.md) for information on
137+
making contributions to the SPDX tools.
138+
139+
## Issues
140+
141+
Report any security related issues by sending an email to [spdx-tools-security@lists.spdx.org](mailto:spdx-tools-security@lists.spdx.org)
142+
143+
Non-security related issues should be added to the [SPDX Tools issues list](https://github.com/spdx/tools-java/issues)

0 commit comments

Comments
 (0)