Commit ae648fee authored by Knut Behrends's avatar Knut Behrends

Update README.md: add hints, correct typo

parent 836f612a
......@@ -6,10 +6,11 @@ Overview
### Description ###
Uses the [OSR](https://github.com/heremaps/oss-review-toolkit) to check for inherent licenses in a given project. Compares them to a given target license that you want so put on the given project.
Uses the [OSS Review Toolkit (OSR)](https://github.com/heremaps/oss-review-toolkit) to check for inherent licenses in a given project. Compares them to a given target license that you want so put on the given project.
Please register or sign in to reply
### Requirements ###
From [OSR](https://github.com/heremaps/oss-review-toolkit/blob/master/docs/GettingStarted.md):
From [ORT](https://github.com/heremaps/oss-review-toolkit/blob/master/docs/GettingStarted.md):
In addition to Java (version >= 8), for some of the supported package managers and Version Control Systems additional
tools need to be installed. In the context of this tutorial the following tools are required:
......@@ -30,3 +31,12 @@ run license checker
```bash
./path/to/licensechecker/run.sh /path/to/project license
```
### Hints
Before running this script, clean up the directories you intend to scan for licenses:
- remove or prune logfiles
- empty cache directories
- remove large text files (perhaps temporarily)
- use common sense
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment