diff --git a/APIs/generateHTML b/APIs/generateHTML deleted file mode 100755 index e4a2348..0000000 --- a/APIs/generateHTML +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/bash - -# Tool to create HTML browseable version of the specifications. -# Requires raml2html (https://github.com/kevinrenskers/raml2html) -# (c) AMWA 2016 - -havecmd () -{ - type $1 > /dev/null 2>&1 -} - -if ! havecmd raml2html; then - echo "Please install raml2html" - exit 1 -fi - -# In case script is run from elsewhere -cd $(dirname "${BASH_SOURCE[0]}") - -# Proper behaviour when no glob match -shopt -s nullglob - -for INFILE in *.raml -do - echo "Found RAML file" $INFILE - OUTFILE=${INFILE%%raml}html - echo $OUTFILE - raml2html $INFILE > $OUTFILE - echo "Generated" $OUTFILE -done -echo "" -echo "Linting..." -jsonlint -v ../examples/*.json -echo "" -jsonlint -v schemas/*.json diff --git a/README.md b/README.md index 5ffb5a4..1cf2aec 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Readers are advised to be familiar with: * The [JT-NM Reference Architecture](http://jt-nm.org/RA-1.0/) * The [overview of Networked Media Open Specifications](https://amwa-tv.github.io/nmos) -Readers should then read the [documentation](docs/) in this repository, and the [APIs](APIs/), which are written in RAML -- if a suitable tool is not available for reading this, then [this](APIs/generateHTML) will create HTML versions. +Readers should then read the [documentation](docs/), [APIs](APIs/) (RAML and JSON Schema), and [examples](examples/) (JSON) > HTML rendered versions of all NMOS Specifications are available on the [NMOS GitHub pages](https://amwa-tv.github.io/nmos)