diff options
author | Steve Winslow <swinslow@gmail.com> | 2018-09-24 16:49:11 -0400 |
---|---|---|
committer | Steve Winslow <swinslow@gmail.com> | 2018-09-24 16:49:11 -0400 |
commit | 0e2fbad12c3672550eb3b2b68f9543ad6c1f3b29 (patch) | |
tree | 88a27196b27fb891c84432180e7c89bfef356227 /README.md | |
parent | 7fbfcfe7e90cab894abb809500d956467cbdf46d (diff) | |
download | spdx-tools-0e2fbad12c3672550eb3b2b68f9543ad6c1f3b29.tar.gz |
Added license and documentation files
Signed-off-by: Steve Winslow <swinslow@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c833cd1 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +SPDX-License-Identifier: CC-BY-4.0 + +# spdx-go + +spdx-go is a collection of Go package intended to make it easier for Go +programs to work with [SPDX®](https://spdx.org/) files. + +This software is in an extremely pre-alpha state (hence the "v0/" directory). + +## What it does + +spdx-go currently works with files conformant to version 2.1 of the SPDX +specification, available at: https://spdx.org/specifications + +spdx-go provides the following packages: + +* *v0/spdx* - in-memory data model for the sections of an SPDX document +* *v0/tvloader* - tag-value file loader + +## What it doesn't do + +spdx-go doesn't currently do any of the following: + +* work with files under any version of the SPDX spec *other than* v2.1 +* work with RDF files +* output RDF or tag-value files +* convert between RDF and tag-value files, or between different versions +* enable applications to interact with SPDX files without needing to care + (too much) about the particular SPDX file version + +As a long-term goal, I am hoping to enable each of these. Code contributions +are welcome! + +## Requirements + +At present, spdx-go does not require anything outside the Go standard library. + +## Licenses + +As indicated in `LICENSE-code.txt`, spdx-go **source code files** are provided +and may be used, at your option, under *either*: +* Apache License, version 2.0 (**Apache-2.0**), **OR** +* GNU General Public License, version 2.0 or later (**GPL-2.0-or-later**). + +As indicated in `LICENSE-docs.txt`, spdx-go **documentation files** are +provided and may be used under the Creative Commons Attribution +4.0 International license (**CC-BY-4.0**). + +This `README.md` file is documentation, hence the CC-BY-4.0 license ID at +the top of the file. |