Skip to content

Commit

Permalink
Minor tweaks to usage and version history
Browse files Browse the repository at this point in the history
  • Loading branch information
jaskarth committed Aug 19, 2024
1 parent 4158a32 commit f0d5e5f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
10 changes: 7 additions & 3 deletions source/usage.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
```

Expand All @@ -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
```
1 change: 1 addition & 0 deletions source/version-history.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit f0d5e5f

Please sign in to comment.