README.adoc in metanorma-0.2.4 vs README.adoc in metanorma-0.2.5
- old
+ new
@@ -14,21 +14,50 @@
document model.
Metanorma includes the following sub-projects:
* 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]
-* M3AAWG Documents (M3D): the AsciiM3D syntax, https://github.com/riboseinc/m3d[M3D Models], the https://github.com/riboseinc/asciidoctor-m3d/[asciidoctor-m3d implementation]
+
+* 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]
+
+* M3AAWG Documents (M3D): the AsciiM3D syntax,
+https://github.com/riboseinc/m3d[M3D Models],
+the https://github.com/riboseinc/asciidoctor-m3d/[asciidoctor-m3d implementation]
+
//* Ribose Specification Documents (RSD): AsciiRSD, RSD XML schema, and the https://github.com/riboseinc/asciidoctor-rsd[asciidoctor-rsd implementation]
== Installation
+=== All-in-one install
+
+macOS users can directly run the Metanorma setup script located here:
+https://github.com/riboseinc/metanorma-macos-setup
+
+This is a one-stop installation script that setups Ruby, Node
+and all necessary parts for running Metanorma.
+
+
+=== Installing individual components
+
The Metanorma workflow can be utilized via the `metanorma` Ruby gem.
[source,sh]
----
gem install metanorma
@@ -40,33 +69,34 @@
* Install Node, with at least version 7.6.0: https://nodejs.org/en/download/,
https://nodejs.org/en/download/package-manager/ . (For Mac, `brew install node`)
* Install npm: https://docs.npmjs.com/getting-started/installing-node
* Install puppeteer: `npm install -g --save --save-exact puppeteer`
+
== Usage
Help command:
[source,sh]
----
$ metanorma -h
Usage: metanorma [options] <file>
- -t, --type TYPE Type of standard to generate: rfc2, rfc3, iso, gb, csd, csand, m3d
- -x, --extensions EXT1,EXT2,... Type of extension to generate per type:
- {
- :rfc2=>{:xmlrfc=>"v2.xml"},
- :rfc3=>{:xmlrfc=>"v3.xml"},
- :iso=>{:html=>"html", :html_alt=>"alt.html", :doc=>"doc"},
- :gb=>{:html=>"html", :doc=>"doc"},
- :csd=>{:html=>"html", :pdf=>"pdf"},
- :csand=>{:html=>"html"},
- :m3d=>{:html=>"html", :doc=>"doc"},
- :rsd=>{:html=>"html"}
- }
- In addition, xml (outside of rfc2, rfc3) generates IsoDoc XML
- -f, --format FORMAT Format of source file: asciidoc (current default, only format supported)
- -r, --require LIBRARY Require LIBRARY prior to execution
- -h, --help Show this message
+ -t, --type TYPE Type of standard to generate: rfc2, rfc3, iso, gb, csd, csand, m3d
+ -x, --extensions EXT1,EXT2,... Type of extension to generate per type:
+ {
+ :rfc2=>{:xmlrfc=>"v2.xml"},
+ :rfc3=>{:xmlrfc=>"v3.xml"},
+ :iso=>{:html=>"html", :html_alt=>"alt.html", :doc=>"doc"},
+ :gb=>{:html=>"html", :doc=>"doc"},
+ :csd=>{:html=>"html", :pdf=>"pdf"},
+ :csand=>{:html=>"html"},
+ :m3d=>{:html=>"html", :doc=>"doc"},
+ :rsd=>{:html=>"html"}
+ }
+ In addition, xml (outside of rfc2, rfc3) generates IsoDoc XML
+ -f, --format FORMAT Format of source file: asciidoc (current default, only format supported)
+ -r, --require LIBRARY Require LIBRARY prior to execution
+ -h, --help Show this message
----
Basically it is used like this:
[source,sh]