diff --git a/CHANGELOG.md b/CHANGELOG.md index cc8ad49..1ddd708 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +# [4.4.0-dev.2](https://github.com/ReVanced/revanced-cli/compare/v4.4.0-dev.1...v4.4.0-dev.2) (2023-12-18) + + +### Bug Fixes + +* Add missing punctuation in command description ([8210351](https://github.com/ReVanced/revanced-cli/commit/821035107d7264580275f395e9e3fcef91394afd)) + +# [4.4.0-dev.1](https://github.com/ReVanced/revanced-cli/compare/v4.3.0...v4.4.0-dev.1) (2023-12-01) + + +### Features + +* Log saved patched APK file path ([16109bd](https://github.com/ReVanced/revanced-cli/commit/16109bd8bc6236debf71cbc8db78fe452b2ed00d)) + # [4.3.0](https://github.com/ReVanced/revanced-cli/compare/v4.2.0...v4.3.0) (2023-12-01) diff --git a/docs/0_prerequisites.md b/docs/0_prerequisites.md index 9e3b481..517ae0e 100644 --- a/docs/0_prerequisites.md +++ b/docs/0_prerequisites.md @@ -4,8 +4,8 @@ To use ReVanced CLI, you will need to fulfill specific requirements. ## 🤝 Requirements -- Java SDK 11 (Azul Zulu JDK or OpenJDK) -- [Android Debug Bridge (adb)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device +- Java Runtime Environment 11 (Azul Zulu JRE or OpenJDK) +- [Android Debug Bridge (ADB)](https://developer.android.com/studio/command-line/adb) if you want to install the patched APK file on your device - An ABI other than ARMv7 such as x86 or x86-64 (or a custom AAPT binary that supports ARMv7) ## ⏭️ Whats next diff --git a/docs/1_usage.md b/docs/1_usage.md index 94c878e..632af0d 100644 --- a/docs/1_usage.md +++ b/docs/1_usage.md @@ -35,7 +35,7 @@ ReVanced CLI is divided into the following fundamental commands: ``` > [!NOTE] -> A default `options.json` file will be automatically created, if it does not exist +> A default `options.json` file will be automatically created if it does not exist without any need for intervention when using the `patch` command. - ### 💉 Patch an app @@ -80,7 +80,7 @@ without any need for intervention when using the `patch` command. - #### 👾 Patch an app and mount it on top of the un-patched app with root permissions > [!IMPORTANT] - > Ensure sure the same app you are patching and mounting over is installed on your device: + > Ensure that the same app you are patching and mounting over is installed on your device: > > ```bash > adb install app.apk @@ -91,14 +91,14 @@ without any need for intervention when using the `patch` command. > patches by their index in relation to supplied patch bundles, > similarly to the option `--include` and `--exclude`. > - > This is useful in case two patches have the same name, and you need to include or exclude one of them. - > The index of a patch is calculated by the position of the patch in the list of patches + > This is useful in case two patches have the same name, and you must include or exclude one. + > The patch index is calculated by the position of the patch in the list of patches > from patch bundles supplied using the option `--patch-bundle`. > > You can list all patches with their indices using the command `list-patches`. > - > Keep in mind, that the indices can change based on the order of the patch bundles supplied, - > as well if the patch bundles are updated, because patches can be added or removed. + > Keep in mind that the indices can change based on the order of the patch bundles supplied, + > as well if the patch bundles are updated because patches can be added or removed. ```bash java -jar revanced-cli.jar patch \ @@ -133,4 +133,4 @@ by adding the option `--unmount`. > [!NOTE] > You can mount an APK file -> by supplying the package name of the app to mount the supplied APK file to over the option `--mount`. +> by supplying the package name of the app to mount the supplied APK file over the option `--mount`. diff --git a/docs/2_building.md b/docs/2_building.md new file mode 100644 index 0000000..7055b4c --- /dev/null +++ b/docs/2_building.md @@ -0,0 +1,26 @@ +# 🔨️ Building + +Build ReVanced CLI from source. + +## 📝 Requirements + +- Java Development Kit 11 (Azul Zulu JRE or OpenJDK) + +## 🏗️ Building + +To build ReVanced CLI, follow these steps: + +1. Clone the repository: + + ```bash + git clone git@github.com:ReVanced/revanced-cli.git + cd revanced-cli + ``` + +2. Build the project: + + ```bash + ./gradlew build + ``` + +After the build succeeds, the built JAR file will be located at `build/libs/revanced-cli--all.jar`. diff --git a/docs/README.md b/docs/README.md index 95a1656..5550101 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,9 @@ # 💻 Documentation and guides of ReVanced CLI -This documentation explains how to use [ReVanced CLI](https://github.com/revanced/revanced-cli). +This documentation contains topics around [ReVanced CLI](https://github.com/revanced/revanced-cli). ## 📖 Table of contents 1. [💼 Prerequisites](0_prerequisites.md) 2. [🛠️ Using ReVanced CLI](1_usage.md) +3. [🔨 Building ReVanced CLI](2_building.md) diff --git a/gradle.properties b/gradle.properties index d9f0d41..5bb8aef 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,4 +1,4 @@ org.gradle.parallel = true org.gradle.caching = true kotlin.code.style = official -version = 4.3.0 +version = 4.4.0-dev.2 diff --git a/settings.gradle.kts b/settings.gradle.kts index 80d7795..47f5152 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -2,6 +2,6 @@ rootProject.name = "revanced-cli" buildCache { local { - isEnabled = !System.getenv().containsKey("CI") + isEnabled = "CI" !in System.getenv() } } diff --git a/src/main/kotlin/app/revanced/cli/command/PatchCommand.kt b/src/main/kotlin/app/revanced/cli/command/PatchCommand.kt index 410c94a..d7b4949 100644 --- a/src/main/kotlin/app/revanced/cli/command/PatchCommand.kt +++ b/src/main/kotlin/app/revanced/cli/command/PatchCommand.kt @@ -325,6 +325,8 @@ internal object PatchCommand : Runnable { alignedFile.renameTo(outputFilePath) } + logger.info("Saved to $outputFilePath") + // endregion // region Install diff --git a/src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt b/src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt index b558fdc..7e01a53 100644 --- a/src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt +++ b/src/main/kotlin/app/revanced/cli/command/utility/UtilityCommand.kt @@ -4,7 +4,7 @@ import picocli.CommandLine @CommandLine.Command( name = "utility", - description = ["Commands for utility purposes"], + description = ["Commands for utility purposes."], subcommands = [InstallCommand::class, UninstallCommand::class], ) internal object UtilityCommand