Skip to content

Commit 7308d85

Browse files
committed
docs(readme): Briefly explain how to build and install plugins
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent 57d6059 commit 7308d85

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ This is a template Gradle project to create a package manager plugin for the [an
55
# Usage
66

77
Create a new repository [from this template], clone it, and replace all occurrences of "MyPackageManager" (search for case-insensitive substrings) with the name of the package manager you are implementing.
8+
Then implement the actual package manager, and when done, run
9+
10+
```shell
11+
./gradlew installDist
12+
```
13+
14+
Finally, copy `./build/install/MyPackageManager/*.jar` to the `plugin` direct of the ORT installation (`/opt/ort/plugin` in ORT's official Docker images).
815

916
[analyzer tool]: https://oss-review-toolkit.org/ort/docs/tools/analyzer
1017
[OSS Review Toolkit]: https://github.com/oss-review-toolkit/ort

0 commit comments

Comments
 (0)