Skip to content

Commit

Permalink
docs: Add notice about authentication
Browse files Browse the repository at this point in the history
  • Loading branch information
oSumAtrIX authored Mar 29, 2024
1 parent 9dd460f commit 2b41fe6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/2_building.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,15 @@ To build ReVanced CLI, follow these steps:
./gradlew build
```

> [!NOTE]
> If the build fails due to authentication, you may need to authenticate to GitHub Packages.
> Create a PAT with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) and add your token to ~/.gradle/gradle.properties.
>
> Example `gradle.properties` file:
>
> ```properties
> gpr.user = user
> gpr.key = key
> ```
After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli-<version>-all.jar`.

0 comments on commit 2b41fe6

Please sign in to comment.