mindustry logic execution, map- and schematic- parsing and rendering
Fix spelling errors in README.md
KosmosPrime 2023-04-12
parent 9296327 · commit 509e063
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index c9fca3c..a7fd38c 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,12 @@ Plandustry is a command-line tool for editing [Mindustry](https://github.com/Anu
## Command-Line usage
The program must be run with a command line first determining the operation to perform, followed by arguments that depend on the operation.
In general, arguments can either be literal (not starting with a dash) short form (starting with a single dash) and long form (starting with a double dash). In
-all cases, arguments are space-delimited or can be wrapped in quotes (but internal quites are considered literal). Both short and long form arguments may be
-passed a value (py), but differ in their syntax and interpretation. Short form arguments are only a single character long, but multiple (even duplicates) can
+all cases, arguments are space-delimited or can be wrapped in quotes (but internal quotes are considered literal). Both short and long form arguments may be
+passed a value, but differ in their syntax and interpretation. Short form arguments are only a single character long, but multiple (even duplicates) can
be used in the same group (following a single dash). This has the advantage that the value following it is passed to all arguments. For example:
- `-a -b -c=value` is 2 arguments with no value (`a` and `b`) and another argument (`c`) with value `value`
- `-ab -xyx` is 5 arguments with no value: `a`, `b`, 2 times `x` and `z`
-- `-hello=world` is 5 arguments: `h`, `e`, 2 times `l` and `o` each (even the double `l`) with the value `world`
+- `-hello=world` is 5 arguments: `h`, `e`, 2 times `l` and `o`, each (even the double `l`) with the value `world`
Long form arguments are simpler: they start with a double dash and may be arbitrarily long. The syntax for passing values is the same but there can only be one
argument per token, and the value only applies to it (such as `--long-form-arg=its-value`).
Note that arguments can forbid, require or permit the inclusion of a value, and some may be used multiple times (as noted below).