Skip to content
Permalink
Browse files

README: Add our new ORT logos

Compared to the original files the logos were adjusted to have their centers
and the start of their titles vertically aligned.

Signed-off-by: Sebastian Schuberth <sebastian.schuberth@here.com>
  • Loading branch information...
sschuberth authored and tsteenbe committed Jan 25, 2019
1 parent cd0eba5 commit e9b506c1458c3c1c77403d5af78992e8d995a118
@@ -1,4 +1,6 @@
# OSS Review Toolkit
![OSS Review Toolkit Logo](./logos/ort.png)

&nbsp;

| Linux (OpenJDK 10) | Windows (Oracle JDK 9) |
| :----------------------------- | :------------------------------ |
@@ -99,7 +101,7 @@ Alternatively, you can also run the OSS Review Toolkit by building its Docker im

## Tools

### [analyzer](./analyzer/src/main/kotlin)
[![Analyzer](./logos/analyzer.png)](./analyzer/src/main/kotlin)

The Analyzer determines the dependencies of software projects inside the specified input directory (`-i`). It does so by
querying whatever [supported package manager](./analyzer/src/main/kotlin/managers) is found. No modifications to your
@@ -110,13 +112,17 @@ JSON, see `-f`) format to a file named `analyzer-result.yml` to the specified ou
exactly documents the status quo of all package-related meta-data. It can be further processed or manually edited before
passing it to one of the other tools.

### [downloader](./downloader/src/main/kotlin)
&nbsp;

[![Downloader](./logos/downloader.png)](./downloader/src/main/kotlin)

Taking an ORT result file with an analyzer result as the input (`-a`), the Downloader retrieves the source code of all
contained packages to the specified output directory (`-o`). The Downloader takes care of things like normalizing URLs
and using the [appropriate VCS tool](./downloader/src/main/kotlin/vcs) to checkout source code from version control.

### [scanner](./scanner/src/main/kotlin)
&nbsp;

[![Scanner](./logos/scanner.png)](./scanner/src/main/kotlin)

This tool wraps underlying license / copyright scanners with a common API so all supported scanners can be used in the
same way to easily run them and compare their results. If passed an ORT result file with an analyzer result (`-a`), the
@@ -132,7 +138,9 @@ artifactory_cache:
apiToken: $ARTIFACTORY_API_KEY
```

### [reporter](./reporter/src/main/kotlin)
&nbsp;

[![Reporter](./logos/reporter.png)](./reporter/src/main/kotlin)

The reporter generates human-readable reports from the scan result file generated by the scanner (`-s`). It is designed
to support multiple output formats. Currently the following report formats are supported:
BIN +8.91 KB logos/advisor.png
Binary file not shown.
BIN +8.79 KB logos/analyzer.png
Binary file not shown.
BIN +9.21 KB logos/documenter.png
Binary file not shown.
BIN +9.57 KB logos/downloader.png
Binary file not shown.
BIN +8.22 KB logos/evaluator.png
Binary file not shown.
BIN +33.7 KB logos/ort.png
Binary file not shown.
BIN +8.52 KB logos/reporter.png
Binary file not shown.
BIN +8.08 KB logos/scanner.png
Binary file not shown.

0 comments on commit e9b506c

Please sign in to comment.
You can’t perform that action at this time.