From e90480b69b39470c84a072da61ae5992dbd8096a Mon Sep 17 00:00:00 2001 From: Sebastian Hartte Date: Fri, 29 Dec 2023 20:24:35 +0100 Subject: [PATCH] Updated README --- README.md | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0a61c43..3c7d683 100644 --- a/README.md +++ b/README.md @@ -27,14 +27,32 @@ the [NeoGradle](https://github.com/neoforged/NeoGradle) build process. It can be invoked as a standalone executable Jar-File. Java 17 is required. ``` -Arguments: - --in Path to input source-jar - --out Path where new source-jar will be written - --names Path to Parchment mappings (JSON or ZIP) or merged TSRG2-mappings - --skip-javadoc Don't apply Javadocs - --queue-depth How many source files to wait for in parallel. 0 for synchronous processing. - 0 for synchronous processing. Default is 50. - --help Print help +Usage: jst [-hV] [--in-format=] [--libraries-list=] + [--max-queue-depth=] [--out-format=] [--enable-parchment + --parchment-mappings= [--parchment-javadoc]] INPUT OUTPUT + INPUT Path to a single Java-file, a source-archive or a folder containing the + source to transform. + OUTPUT Path to where the resulting source should be placed. + -h, --help Show this help message and exit. + --in-format= + Specify the format of INPUT explicitly. AUTO (the default) performs + auto-detection. Other options are SINGLE_FILE for Java files, ARCHIVE + for source jars or zips, and FOLDER for folders containing Java code. + --libraries-list= + Specifies a file that contains a path to an archive or directory to add + to the classpath on each line. + --max-queue-depth= + When both input and output support ordering (archives), the transformer + will try to maintain that order. To still process items in parallel, + a queue is used. Larger queue depths lead to higher memory usage. + --out-format= + Specify the format of OUTPUT explicitly. Allows the same options as + --in-format. + -V, --version Print version information and exit. +Plugin - parchment + --enable-parchment Enable parchment + --parchment-javadoc + --parchment-mappings= ``` ## Licenses