Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 1.12 KB

README.md

File metadata and controls

19 lines (12 loc) · 1.12 KB

Build Status

Status

This repository contains the official source of the CF metadata conventions. The source files are built into HTML (see below), thw output of which can be seen at: http://cfconventions.org/cf-conventions/cf-conventions.html.

For the official web site please visit: http://cfconventions.org/, and the corresponding GitHub organisation: https://github.com/cf-convention.

Building the HTML

To convert the AsciiDoc files into the resulting HTML file:

  1. Ensure you have Ruby installed (e.g. sudo apt-get install ruby)
  2. Ensure you have a recent version of Asciidoctor installed (e.g. gem install asciidoctor)
  3. Get hold of the AsciiDoc files in this repo (e.g. git clone [email protected]:cf-metadata/cf-conventions.git)
  4. Build the HTML: asciidoctor cf-conventions.adoc

See the GitHub help pages and plethora of other git/GitHub guides for more details on how to work with repos, forks, pull requests, etc.