Skip to content

Commit af8b1d1

Browse files
committed
finish docs
1 parent 8ca3d15 commit af8b1d1

File tree

10 files changed

+593
-434
lines changed

10 files changed

+593
-434
lines changed

docs/2_1_setup.md renamed to docs/1_setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060

6161
# 👶 Setting up a development environment
6262

63-
To start developing patches with ReVanced Patcher, you must prepare a development environment.
63+
To use ReVanced Patcher, a development environment must be set up.
6464

6565
## 📝 Prerequisites
6666

@@ -107,6 +107,6 @@ Throughout the documentation, [ReVanced Patches](https://github.com/revanced/rev
107107
108108
## ⏭️ What's next
109109
110-
The next page will go into details about a ReVanced patch.
110+
The next page introduces the basics of ReVanced Patcher.
111111
112-
Continue: [🧩 Anatomy of a patch](2_2_patch_anatomy.md)
112+
Continue: [💉 Introduction to ReVanced Patcher](2_patcher_intro.md)

docs/2_2_1_fingerprinting.md

Lines changed: 0 additions & 296 deletions
This file was deleted.
Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,11 @@ val patch = patcher(apkFile = File("app.apk")) { packageName, versionName ->
8484
}
8585
```
8686

87-
The `patcher` function returns a `patch` lambda that you can later execute to apply the patches to the APK file.
87+
The `patcher` function returns a `patch` function that you can later execute to apply the patches to the APK file.
8888
On execution, `PatchResult` objects for each patch are emitted in the provided lambda.
89-
You can use this to log the success or failure of each patch:
89+
You can use this to log the success or failure of each patch.
90+
The `patch` function finally returns a `patchesResult` containing the modified components of the APK file,
91+
ready for repackaging:
9092

9193
```kt
9294
val patchesResult = patch { patchResult ->
@@ -99,17 +101,14 @@ val patchesResult = patch { patchResult ->
99101
logger.severe("\"${patchResult.patch}\" failed:\n$writer")
100102
}
101103
}
102-
```
103-
104-
At last, the `patchesResult` returned by the `patch` lambda contains the modified components of the APK file.
105104

106-
```kt
107105
val dexFiles = patchesResult.dexFiles
108106
val resources = patchesResult.resources
109107
```
110108

109+
111110
## ⏭️ What's next
112111

113-
The next page teaches the fundamentals of ReVanced Patches.
112+
The next page introduces the basics of ReVanced Patches.
114113

115-
Continue: [🧩 Introduction to ReVanced Patches](2_patches_intro.md)
114+
Continue: [🧩 Introduction to ReVanced Patches](3_patches_intro.md)

0 commit comments

Comments
 (0)