README fix

This commit is contained in:
perro tuerto 2023-01-25 18:00:59 -08:00
parent 0afeca617b
commit dfbaa98af6
1 changed files with 17 additions and 29 deletions

View File

@ -364,39 +364,27 @@ Mandatory.
## Command-Line Interface
```
yasd [-q | -l] CMD
usage: yasd [-h] [-q] [-l] [-n NUM] {convert,check,sample,document,man} [file]
CMD (mandatory and only one at once):
YASD, Yet Another Schema Definition. YASD is a YAML format for human writable
XSDs (XML Schema Definition), humans declare what is indispensable, leaving
the machines to do the rest of the unreadable <syntaxis who_can_read_this="?"
/>.
convert [-f xsd | json] FILE
check FILE
sample [-n INT] FILE
man
help
positional arguments:
{convert,check,sample,document,man}
action to perform
file file in YAML format
ARGS:
options:
-h, --help show this help message and exit
-q, --quiet enable quiet mode
-l, --log write log
-n NUM, --num NUM number of XML samples; 1 by default
-q | --quiet No prints; doesn't apply for man and help.
-l | --logs Writes logs.
-f | --format Format type; could be 'xsd' or 'json'; 'xsd' by default.
-n | --num Number of samples; 1 by default.
convert Converts YASD file to XSD or JSON format; XSD by default.
check Validates YASD file.
sample Writes XML samples according to schema.
man Prints README.md
help Prints this.
FILE YAML file; file extension doesn't matter.
EXAMPLES:
yasd convert schema.yasd
yasd --quiet --logs convert schema.yasd
yasd -ql -f json convert schema.yasd
yasd check schema.yaml
yasd sample schema.yasd
yasd sample -n 10 schema.yaml
yasd man
yasd help
(c) 2023 Perro Tuerto <hi@perrotuerto.blog>. Founded by Mexican Academy of
Language <https://academia.org.mx>. Licensed under GPLv3
<https://www.gnu.org/licenses/gpl-3.0.en.html>.
```
[^1]: The following explanation is practically a copy-paste from "XSD - The