From a01bd27f1074cbb2a4c12785780b83d561e2beee Mon Sep 17 00:00:00 2001 From: EpicPlayerA10 <62206933+EpicPlayerA10@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:08:22 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b3935d3..eaca3c74 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ The project is structured as follows: - [`compiled/custom-jars`](./testData/compiled/custom-jars) - Jars to test transformers. You can throw here your obfuscated jars. - `deobfuscated` - Raw classes after deobfuscation process. Useful when debugging. - [`results`](./testData/results) - Expected results that are auto-generated decompiled java code. -- [`TestDeobfuscation.java`](./deobfuscator-impl/src/test/java/uwu/narumii/deobfuscator/TestDeobfuscation.java) - Class where each test sample is registered. +- [`TestDeobfuscation.java`](./deobfuscator-impl/src/test/java/uwu/narumi/deobfuscator/TestDeobfuscation.java) - Class where each test sample is registered. - [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java) - Class where you can run deobfuscator manually. ## 🧰 Recommended tools @@ -32,9 +32,9 @@ Whole deobfuscation process is based on transformers. Transformers are smaller p ## 🧪 Testing ### How these tests work? -1. The registered samples are transformed using corresponding transformers. +1. The [registered samples](./deobfuscator-impl/src/test/java/uwu/narumi/deobfuscator/TestDeobfuscation.java) are transformed using corresponding transformers. 2. The output gets decompiled using Vineflower. -3. The output gets compared with the expected output. +3. The decompiled code is compared against the [expected output](./testData/results). ### How to run tests? Just run command `mvn test` in the root directory of the project. @@ -45,5 +45,5 @@ You can create your own tests for transformers. There are a few ways to do it: - If the obfuscation is more complex, you can throw your raw obfuscated classes (`.class` files) into [`testData/compiled/custom-classes`](./testData/compiled/custom-classes) and test transformers on them. - You can also throw your obfuscated jars into [`testData/compiled/custom-jars`](./testData/compiled/custom-jars) and test transformers on them. -You also need to register each sample in class [TestDeobfuscation.java](./deobfuscator-impl/src/test/java/uwu/narumii/deobfuscator/TestDeobfuscation.java) +You also need to register each sample in class [TestDeobfuscation.java](./deobfuscator-impl/src/test/java/uwu/narumi/deobfuscator/TestDeobfuscation.java)