Skip to content

Commit 971c157

Browse files
committed
Update readme
1 parent 904ead0 commit 971c157

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,33 @@
33
Vineflower is a modern, general purpose JVM language decompiler focused on providing the best quality, speed, and usability.
44

55
Vineflower's features include:
6-
- Java 20+ support, including records, sealed classes, switch expressions, and more
6+
- Java 21+ support, including records, sealed classes, switch expressions, pattern matching, and more
77
- Clean code generation and output, with automatic output formatting
88
- Multithreaded decompilation
99

1010
Examples of Vineflower's output, compared to other decompilers, can be found on [the wiki.](https://github.com/Vineflower/vineflower/wiki)
1111

1212
## Use
13-
Want to use Vineflower? There are a few ways! For Minecraft modding, [Loom Vineflower](https://github.com/Juuxel/loom-vineflower) allows you to generate sources with Vineflower.
14-
The [Vineflower Intellij IDEA plugin](https://plugins.jetbrains.com/plugin/18032-quiltflower) replaces Fernflower in IDEA with Vineflower, and allows you to modify its settings.
13+
Want to use Vineflower? There are a few ways! The [Vineflower Intellij IDEA plugin](https://plugins.jetbrains.com/plugin/18032-quiltflower) replaces Fernflower in IDEA with Vineflower, and allows you to modify its settings.
1514

1615
If you want to run Vineflower from the commandline, head over to the [Releases tab](https://github.com/Vineflower/vineflower/releases) and grab the latest release.
1716
You can then run Vineflower with `java -jar vineflower.jar <arguments> <source> <destination>`.
1817
`<arguments>` is the list of [commandline arguments](https://github.com/Vineflower/vineflower/wiki) that you want to pass to the decompiler.
19-
`<source>` can be a jar, zip, folder, or class file, and `<destination>` can be a folder, zip, jar, or excluded, to print to the console.
18+
`<source>` can be a jar, zip, folder, or class file, and `<destination>` can be a folder, zip, jar, or excluded to print to the console.
2019

21-
22-
To use Vineflower as a library, you can find distributions on maven central. Vineflower 1.9+ requires Java 11 or higher to run.
20+
To use Vineflower as a library, you can find distributions on maven central. Vineflower 1.9+ requires Java 11 or higher to run, and Vineflower 1.11+ requires Java 17 or higher to run.
2321
Vineflower can be imported with gradle with:
2422
```groovy
2523
dependencies {
2624
implementation 'org.vineflower:vineflower:<version>'
2725
}
2826
```
27+
Vineflower 1.10+ provides two artifacts, the regular jar and the slim jar. The regular jar contains the decompiler and a handful of plugins, such as a Kotlin decompiler and variable renamer.
28+
The slim jar contains only the decompiler. If unsure, simply use the regular jar as before.
29+
2930
Instructions on how to interface with Vineflower can be found on [the wiki.](https://github.com/Vineflower/vineflower/wiki)
3031

31-
Make sure to report any issues to the [Issues tab!](https://github.com/Vineflower/vineflower/issues)
32+
Please report any issues to the [Issues tab!](https://github.com/Vineflower/vineflower/issues)
3233

3334
### Building
3435
Vineflower can be built simply with `./gradlew build`.
@@ -40,9 +41,14 @@ For support or questions, please join one of the listed [social platforms](https
4041
Contributions are always welcome! We are always looking for help with bugfixes, new features, and enhancements. If you'd like to work on a feature or bugfix, feel free to simply open a PR! If you want to communicate about a change before making it, you can get in touch with the methods listed above.
4142
Vineflower's codebase is rather old and some concepts may be difficult to navigate. For help, please check out [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md).
4243

44+
### Pull Requests
45+
When submitting pull requests, please target the latest `develop/1.xx.y` branch.
46+
4347
### Special Thanks
44-
Vineflower is a fork of both Jetbrains' Fernflower and MinecraftForge's ForgeFlower, and a direct continuation of work on Quiltflower.
48+
Vineflower is a fork of Jetbrains' Fernflower, MinecraftForge's ForgeFlower, FabricMC's fork of Fernflower, and a direct continuation of work on Quiltflower.
4549

50+
* Stiver- For creating Fernflower
4651
* Jetbrains- For maintaining Fernflower
4752
* Forge Team- For maintaining ForgeFlower
53+
* Fabric Team- For maintaining Fabric's fork of Fernflower
4854
* CFR- For its large suite of very useful tests

0 commit comments

Comments
 (0)