# README
Licensecheck
The licensecheck package scans source texts for known licenses.
The design aims never to give a false positive.
It also reports matches of known license URLs.
See the package documentation for API details.
The license scanner recognizes nearly all the licenses gathered by the SPDX project, along with a few others.
See licenses/README.md for license details.
# Packages
Package old is an old (v0.1.0) copy of the licensecheck package, for easier comparison with the new Scan API.
# Functions
BuiltinLicenses returns the list of licenses built into the package.
NewScanner returns a new Scanner that recognizes the given set of licenses.
ParseType parses s into a Type.
Scan computes the coverage of the text according to the license set compiled into the package.
# Constants
Discouraged indicates that there is some legal problem with the license, making it difficult to comply with or vague about what it permits.
NonCommercial indicates that commercial use of the software is disallowed.
Notice indicates that the license carries notice or advertising requirements.
ShareChanges indicates that source and binary distributions must include source code for any modifications made to the original code itself, made available under the same license as the original.
ShareProgram indicates that source and binary distributions must include source code for the entire program using the original code library, made available under the same license as the original.
ShareServer indicates that any server program making use of the source code must provide a download link for the entire source code of the server.
Unknown indicates that the license requirements are unknown.
Unrestricted indicates that the license carries no requirements.
# Type aliases
Type is a bit set describing the requirements imposed by a license or group of licenses.