Skip to content

Commit

Permalink
docs(README): Update the installation from binaries section
Browse files Browse the repository at this point in the history
End-users should not downloads JARs from Maven Central, but use the
distribution archives.

Resolves #9749.

Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Jan 15, 2025
1 parent c40a759 commit 9d1a14d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,12 @@ If a package manager is not list listed there, support for it is integrated dire

## From binaries

Binary artifacts for releases are published to [Maven Central](https://central.sonatype.com/namespace/org.ossreviewtoolkit).
Head over to the [releases](https://github.com/oss-review-toolkit/ort/releases) page.
From the "Assets" section of your chosen release, download the distribution archive of the desired type.
Typically that is `.zip` for Windows and `.tgz` otherwise; but the contents of the archives are the same.
The `ort-*` archives contain the [ORT main](./cli/) distribution, while the `orth-*` archives contain the [ORT helper](./helper-cli/) distribution.
Unpack the archive to an installation directory.
The scripts to run ORT are located at `bin/ort` and `bin\ort.bat`, or `bin/orth` and `bin\orth.bat`, respectively.

## From sources

Expand Down

0 comments on commit 9d1a14d

Please sign in to comment.