Commit 836f612a authored by thc's avatar thc

changed description

parent 2ec2d27b
...@@ -4,7 +4,7 @@ licensechecker ...@@ -4,7 +4,7 @@ licensechecker
Overview Overview
-------- --------
### Desciption ### ### 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 [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.
...@@ -15,13 +15,18 @@ In addition to Java (version >= 8), for some of the supported package managers a ...@@ -15,13 +15,18 @@ In addition to Java (version >= 8), for some of the supported package managers a
tools need to be installed. In the context of this tutorial the following tools are required: tools need to be installed. In the context of this tutorial the following tools are required:
* Git (any recent version will do) * Git (any recent version will do)
* Docker 19.* or higher
* [Node.js](https://nodejs.org) 8.* * [Node.js](https://nodejs.org) 8.*
* [NPM](https://www.npmjs.com) 5.5.* - 6.4.* * [NPM](https://www.npmjs.com) 5.5.* - 6.4.*
* [Yarn](https://yarnpkg.com) 1.9.* - 1.17.* * [Yarn](https://yarnpkg.com) 1.9.* - 1.17.*
### Running ### ### Running ###
run will use the oss review toolkit by heremaps start docker
https://github.com/heremaps/oss-review-toolkit ```bash
it expects the docker daemon running sudo systemctl start docker.service
make sure to se the env variables to a place outside the project ```
run license checker
```bash
./path/to/licensechecker/run.sh /path/to/project license
```
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