search

spdx / tools

SPDX Tools
Apache License 2.0
126 stars 69 forks source link

Add descriptions for different tools in README #183

Closed silverhook closed 5 years ago

silverhook commented 5 years ago

While the README file and the --help flag are already really useful, it is missing info on what the individual tools actually do.

While with Verify and RdfToTag it is quite self-explanatory, tools like LicenseRDFAGenerator are a mystery to a newcomer.

silverhook commented 5 years ago

It seems the PDF documentation can be obtained from https://spdx.org/tools.

Perhaps a copy or link would be useful :)

goneall commented 5 years ago

@silverhook Thanks for pointing this out. Some of the information looks a bit stale as well. I'll make a pass at the documentation and update it over the next week or so.

goneall commented 5 years ago

Resolved with PR #184

@silverhook if you see any other improvements for the documentation, feel free to create a PR. The help text is at https://github.com/spdx/tools/blob/2fa4314cc14c220b0c2205a969aa9b4eed021d4a/src/org/spdx/tools/Main.java#L67

silverhook commented 5 years ago

Perfect, thank you @goneall :+1: