ReVanced-Mirror
/
revanced-documentation
mirror of https://github.com/revanced/revanced-documentation.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Fix mistakes

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

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

@ -2,33 +2,35 @@
A certain development environment is suggested to allow for streamlined development on ReVanced.
## 1. ⬇️ Clone repositories
## 🚀 Get started
```bash
mkdir revanced && cd revanced
1. ⬇️ Clone repositories
repositories=(
```bash
mkdir revanced && cd revanced
repositories=(
"revanced-cli"
"revanced-patches"
"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
for repository in "${repositories[@]}" ; do
git clone -b dev --single-branch --depth 1 https://github.com/revanced/$repository
done
```
done
```
## 2. 🛠️ Build
2. 🛠️ Build
To build all projects, run the following command from the directory which contains the repositories.
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
```
```bash
for project in */; do
cd "$project" && ./gradlew build
done
```
> [!NOTE]
> If the build fails due to authentication, you may need to authenticate to GitHub Packages.
@ -41,7 +43,7 @@ done
> 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)
2. Import other projects you cloned earlier as modules to the `revanced-cli` project
@ -84,7 +86,7 @@ done
> by running `./gradlew publishToMavenLocal`.
> 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: