From 2b41fe6d0b5ff95a8a7427a6663eb66f6cf3f86f Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Fri, 29 Mar 2024 18:41:15 +0100 Subject: [PATCH] docs: Add notice about authentication --- docs/2_building.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/2_building.md b/docs/2_building.md index 7376562..864400a 100644 --- a/docs/2_building.md +++ b/docs/2_building.md @@ -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--all.jar`.