From f0d5e5fc34373bf0cf2b1b5d1a56878056fec03c Mon Sep 17 00:00:00 2001 From: Jasmine Karthikeyan <25208576+jaskarth@users.noreply.github.com> Date: Sun, 18 Aug 2024 21:52:37 -0400 Subject: [PATCH] Minor tweaks to usage and version history --- source/usage.md | 10 +++++++--- source/version-history.md | 1 + 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/source/usage.md b/source/usage.md index c980aac..55e3690 100644 --- a/source/usage.md +++ b/source/usage.md @@ -1,11 +1,13 @@ -# Usage +# Usage (Command Line) -Vineflower can be run as a CLI tool. +Vineflower can be run from the command line. ```shell java -jar vineflower.jar [args...] {in}+ [{out}] ``` +Vineflower also accepts arguments to change decompilation behavior. + ## Arguments % Several arguments are handled specially in the codebase so they do not have annotations which can be examined on their own @@ -28,7 +30,7 @@ The following three options control how decompiled output should be written. If Prefer saving to a folder, potentially extracting an input archive. ``` -```{option} --legacy +```{option} --legacy-saving Use legacy Fernflower save behavior. ``` @@ -40,5 +42,7 @@ Only members whose paths start with `prefix` will be emitted % The rest can be automatically inferred from IFernflowerPreferences +The following values change the decompilation behavior itself. + ```{include} generated/usage.md ``` diff --git a/source/version-history.md b/source/version-history.md index 0464717..1db41d1 100644 --- a/source/version-history.md +++ b/source/version-history.md @@ -1,4 +1,5 @@ # Version History +This page is automatically generated based on [https://github.com/Vineflower/vineflower/releases](https://github.com/Vineflower/vineflower/releases). :::{changelog} :changelog-url: https://vineflower.org/version-history