ReVanced-Mirror/revanced-documentation
1
0
Fork 0
mirror of https://github.com/revanced/revanced-documentation.git synced 2025-01-30 04:17:34 +01:00
Code Issues Projects Releases Wiki Activity

docs: Fix mistakes

Browse Source
This commit is contained in:
oSumAtrIX 2024-02-25 06:23:03 +01:00 committed by GitHub
parent 9a0a51380b
commit bc39e89b05
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/revanced-development/1_setup.md
View File

@ -2,34 +2,36 @@
A certain development environment is suggested to allow for streamlined development on ReVanced. A certain development environment is suggested to allow for streamlined development on ReVanced.
## 1. ⬇️ Clone repositories ## 🚀 Get started
```bash 1. ⬇️ Clone repositories
mkdir revanced && cd revanced
```bash
repositories=( mkdir revanced && cd revanced
"revanced-cli"
"revanced-patches" repositories=(
"revanced-patcher" # Only if you want to work on ReVanced Patcher "revanced-cli"
"revanced-library" # Only if you want to work on ReVanced Library "revanced-patches"
"revanced-integrations" "revanced-patcher" # Only if you want to work on ReVanced Patcher
) "revanced-library" # Only if you want to work on ReVanced Library
"revanced-integrations"
for repository in "${repositories[@]}" ; do )
git clone -b dev --single-branch --depth 1 https://github.com/revanced/$repository
done for repository in "${repositories[@]}" ; do
``` git clone -b dev --single-branch --depth 1 https://github.com/revanced/$repository
done
## 2. 🛠️ Build ```
To build all projects, run the following command from the directory which contains the repositories.
```bash
for project in */; do
(cd "$project" && ./gradlew build)
done
```
2. 🛠️ Build
To build all projects, run the following command from the directory which contains the repositories.
```bash
for project in */; do
cd "$project" && ./gradlew build
done
```
> [!NOTE] > [!NOTE]
> If the build fails due to authentication, you may need to authenticate to GitHub Packages. > 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. > 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.
@ -41,7 +43,7 @@ done
> gpr.key = key > gpr.key = key
> ``` > ```
## ⚙️ Workspace setup in IntelliJ IDEA ## ⚙️ Setup your workspace in IntelliJ IDEA
1. Open the `revanced-cli` project in IntelliJ IDEA and ensure you are using the right JDK from [💼 Prerequisites](0_prerequisites.md) 1. Open the `revanced-cli` project in IntelliJ IDEA and ensure you are using the right JDK from [💼 Prerequisites](0_prerequisites.md)
2. Import other projects you cloned earlier as modules to the `revanced-cli` project 2. Import other projects you cloned earlier as modules to the `revanced-cli` project
@ -84,7 +86,7 @@ done
> by running `./gradlew publishToMavenLocal`. > by running `./gradlew publishToMavenLocal`.
> You can now use them as dependencies in local projects such as `revanced-patches` or `revanced-cli`. > You can now use them as dependencies in local projects such as `revanced-patches` or `revanced-cli`.
## 5. ⚠️ Troubleshoot your development environment ## ⚠️ Troubleshoot your development environment
Confirm that your development environment works as intended: Confirm that your development environment works as intended: