Skip to content

Commit 1771c9e

Browse files
luioxEpicPlayerA10
authored andcommitted
Update README and CONTRIBUTING
Remove unnecessary Git configuration content and add new precautions
1 parent 3b20e6f commit 1771c9e

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,14 @@ The above example shows that the value is produced by `ldc` instruction, but it
230230

231231
The project is also greatly documented, so you can find more information about any class or transformer in their javadocs and comments inside the code. You can also view other transformers' code - see how they work and how they are implemented. There are also tests, so you can, for example, see how the transformer behaves when you modify some line of code.
232232

233+
## ❗Attention
234+
235+
### Change the too long class file name
236+
237+
Class files with long file names generated by obfuscator should not be directly submitted to Git, as this will cause Git to display the file as too long.
238+
239+
Modifying the class file name will not have any impact on processing ClassNodes, but a file name that is too long can cause git pull failures.
240+
233241
## 🧪 Testing
234242
### How do these tests work?
235243
The deobfuscator has a clever testing system. It works as follows:

README.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,19 @@ A deobfuscator for java
77
If you want to use this deobfuscator, you need to start it from your IDE manually.
88

99
1. Clone this repository and open it in IntelliJ
10-
2. (Windows) Open cmd as administrator and run `git config --system core.longpaths true` to enable long paths support
11-
3. Make sure that you have selected [Java 17 (Temurin)](https://adoptium.net/temurin/releases/?version=17) in `Project Structure` -> `SDK`
12-
4. Place your obfuscated jar inside the root project directory. For example in `work/obf-test.jar`
13-
5. Navigate to class [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java)
14-
6. In this class edit the deobfuscator configuration
10+
2. Make sure that you have selected [Java 17 (Temurin)](https://adoptium.net/temurin/releases/?version=17) in `Project Structure` -> `SDK`
11+
3. Place your obfuscated jar inside the root project directory. For example in `work/obf-test.jar`
12+
4. Navigate to class [`Bootstrap.java`](./deobfuscator-impl/src/test/java/Bootstrap.java)
13+
5. In this class edit the deobfuscator configuration
1514
- `inputJar` - Your obfuscated jar file that you placed in step 1
1615
- `transformers` - Pick transformers that you want to run. You can find them in [`deobfuscator-transformers`](./deobfuscator-transformers/src/main/java/uwu/narumi/deobfuscator/core/other) module.
17-
7. Run this class manually from your IDE. You can use our pre-configured IntelliJ task named `Bootstrap`.
16+
6. Run this class manually from your IDE. You can use our pre-configured IntelliJ task named `Bootstrap`.
1817

1918
![tak](./assets/run-deobfuscator.gif)
2019

2120
## 🔧 Contributing
2221
Contributions are welcome! See [CONTRIBUTING.md](./CONTRIBUTING.md) for a project introduction and some basics about java bytecode.
2322

24-
## Attention
25-
26-
### Change the too long class file name
27-
28-
Class files with long file names generated by obfuscator should not be directly submitted to Git, as this will cause Git to display the file as too long.
29-
30-
Modifying the class file name will not have any impact on processing ClassNodes, but a file name that is too long can cause git pull failures.
31-
3223
## Links
3324

3425
<a href="https://discord.gg/tRU27KtPAZ"><img src="https://discordapp.com/api/guilds/900083350314811432/widget.png?style=banner2"/></a>

0 commit comments

Comments
 (0)