README.adoc in metanorma-0.1.1 vs README.adoc in metanorma-0.1.2
- old
+ new
@@ -18,10 +18,11 @@
* The https://github.com/riboseinc/standoc-models[Metanorma document model (previously called StanDoc)]
* IETF Internet-Drafts and RFCs: the https://datatracker.ietf.org/doc/draft-ribose-asciirfc/[AsciiRFC syntax], the https://github.com/riboseinc/asciidoctor-rfc/[asciidoctor-rfc RFC XML v2 and v3 implementations]
* ISO Standards: the AsciiISO syntax, the https://github.com/riboseinc/isodoc-models/[IsoDoc Models], the https://github.com/riboseinc/asciidoctor-iso/[asciidoctor-iso IsoDoc implementation]
* CalConnect Standard Documents (CSD): the AsciiCSD syntax, https://github.com/riboseinc/csd[CSD Models], the https://github.com/riboseinc/asciidoctor-csd/[asciidoctor-csd implementation]
* Chinese GuoBiao (GB) Standards: the AsciiGB syntax, https://github.com/riboseinc/gbdoc[GbDoc Models], the https://github.com/riboseinc/asciidoctor-gb/[asciidoctor-gb implementation]
+* Cloud Security Alliance Normal Documents (CSAND): the AsciiCSAND syntax, https://github.com/riboseinc/csand[CSAND Models], the https://github.com/riboseinc/asciidoctor-csand/[asciidoctor-csand implementation]
//* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/asciidoctor-rsd[asciidoctor-rsd implementation]
== Installation
@@ -33,18 +34,31 @@
----
== Usage
+Help command:
+
[source,sh]
----
+$ metanorma -h
+Usage: metanorma [options] <file>
+ -t, --type TYPE Type of standard to generate: rfc2, rfc3, iso, gb, csd
+ -f, --format FORMAT Format of source file: asciidoc (current default, only format supported)
+ -h, --help Show this message
+----
+
+Basically it is used like this:
+
+[source,sh]
+----
metanorma --type <chosen-type> [--format input-format] iso-my-standard-document.adoc
----
Options:
//, `rsd`
-`type`:: (specified via `--type` or `-t`) takes one of the following types:
+`type`:: (mandatory, specified via `--type` or `-t`) takes one of the following types:
`rfc2`, `rfc3`, `iso`, `gb`, `csd`
`format`:: (specified via `--format` or `-f`) only accepts `asciidoc` for now