= Internet Draft: OpenPGP SCA Extensions

image:https://img.shields.io/travis/riboseinc/rfc-openpgp-sca/master.svg[ Build Status, link="https://travis-ci.org/riboseinc/rfc-openpgp-sca"]

This Internet-Draft is written in pure AsciiDoc using the excellent https://github.com/riboseinc/asciidoctor-rfc[`asciidoctor-rfc` gem].

== Fetching the document

[source,sh]

git clone https://github.com/riboseinc/rfc-openpgp-sca

== Installing Build Tools

You will need Ruby, xml2rfc and idnits (for submission preflight).

=== On macOS

[source,sh]

brew install idnits brew install python easy_install pip pip install -r requirements.txt gem install bundler bundle install

== Building the document

[source,sh]

make all

or

export ID_NAME=ribose-openpgp-sca make draft-${ID_NAME}.txt

== Checking Against idnits

https://tools.ietf.org/tools/idnits/[idnits] is the RFC checking tool prior to submissions.

The make target finds exactly the document name from the :name: document attribute and puts the file in the right place before calling idnits to prevent it complaining about the location.

[source,sh]

export ID_NAME=ribose-openpgp-sca make draft-${ID_NAME}.nits

== Checking for invalid / unicode characters

[source,sh]

export ID_NAME=ribose-openpgp-sca pcregrep --color='auto' -n "[\x80-\xFF]" draft-${ID_NAME}.xml

== Iterating the document

[source,sh]

export ID_NAME=ribose-openpgp-sca make clean all; open draft-${ID_NAME}.txt