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

README.md convert example needs to be updated #33

Closed
riyenas0925 opened this issue Oct 2, 2021 · 2 comments · Fixed by #34
Closed

README.md convert example needs to be updated #33

riyenas0925 opened this issue Oct 2, 2021 · 2 comments · Fixed by #34

Comments

@riyenas0925
Copy link
Contributor

riyenas0925 commented Oct 2, 2021

Hello
First of all, thank you for making a good tool.

  • java-tools supports conversion to json and yaml, but it is not shown in README.md
  • In the spdx format converters section of the readme.md file, we checked that the example was different from the actual one.
    AS-IS : java -jar spdx-tools-jar-with-dependencies.jar TagToRDF Examples/SPDXTagExample.tag TagToRDF.rdf
    TO-BE : java -jar spdx-tools-jar-with-dependencies.jar Convert Examples/SPDXTagExample.tag TagToRDF.rdf

reference

Usage: java -jar spdx-tools-jar-with-dependencies.jar <function> <parameters>
function                 parameter                         example
-------------------------------------------------------------------------------------------------------------------
Convert         inputFile outputFile [fromType] [toType]   Examples/SPDXTagExample.tag TagToSpreadsheet.xls
SPDXViewer      inputFile                                  TestFiles/SPDXRdfExample.rdf
Verify          inputFile [type]                           TestFiles/SPDXRdfExample.rdf
CompareDocs     output.xlsx doc1 doc2 ... docN
GenerateVerificationCode sourceDirectory
Version
MatchingStandardLicenses licenseTextFile

can I contribute by revising README.md and sending pr?

Thank you!

@goneall
Copy link
Member

goneall commented Oct 2, 2021

@riyenas0925 - Good catch on the documentation.

Yes - please go ahead and submit a PR.

Thanks!

riyenas0925 added a commit to riyenas0925/tools-java that referenced this issue Oct 2, 2021
Update convertible SPDX format
Fix incorrect spdx conversion example

Resolves spdx#33

Signed-off-by: riyenas0925 <riyenas0925@gmail.com>
@riyenas0925
Copy link
Contributor Author

Dear @goneall
pr requested 😄
please let me know if there is anything I need to change

riyenas0925 added a commit to riyenas0925/tools-java that referenced this issue Oct 2, 2021
Update convertible SPDX format
Fix incorrect spdx conversion example

Resolves spdx#33

Signed-off-by: riyenas0925 <riyenas0925@gmail.com>
riyenas0925 added a commit to riyenas0925/tools-java that referenced this issue Oct 2, 2021
Update convertible SPDX format
Fix incorrect spdx conversion example

Resolves spdx#33

Signed-off-by: riyenas0925 <riyenas0925@gmail.com>
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 a pull request may close this issue.

2 participants