diff --git a/README.md b/README.md index 72e6c46f..23dc8225 100644 --- a/README.md +++ b/README.md @@ -1,33 +1 @@ -[![Build Status](https://secure.travis-ci.org/cf-convention/cf-conventions.png)](http://travis-ci.org/cf-convention/cf-conventions) - -This repository contains the official source of the CF metadata conventions. -The source files are built into HTML automatically when changes are merged into this repository. -The latest build of the specification is held in the `gh-pages` branch and can be seen [here](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). - -# Contributing to the CF Conventions -The CF Conventions are changed by changing the source files in this repository. -The rules for doing this are set forth on the [CF website](http://cfconventions.org/rules.html). -Their implementation in GitHub is described in this repository's [CONTRIBUTING.md file](https://github.com/cf-convention/cf-conventions/blob/master/CONTRIBUTING.md). - -# Building the HTML - -To convert the AsciiDoc files into the resulting HTML file: - -1. Ensure you have [Ruby](https://www.ruby-lang.org/) installed (e.g. `sudo apt-get install ruby`) -2. Ensure you have a recent version of [Asciidoctor](http://asciidoctor.org/) installed (e.g. `gem install asciidoctor`) -3. Get hold of the AsciiDoc files in this repo (e.g. `git clone git@github.com:cf-metadata/cf-conventions.git`) -4. Build the HTML: `asciidoctor cf-conventions.adoc` - -See the [GitHub help](https://help.github.com/) pages and plethora of other git/GitHub guides for more details on how to work with repos, forks, pull requests, etc. - -### Latest Spec Build - -Whenever a [pull request](https://github.com/cf-convention/cf-conventions/pulls) is merged, a [travis-ci build](https://travis-ci.org/github/cf-convention/cf-conventions) generates the latest specification draft and adds it to the [gh-pages branch here](https://github.com/cf-convention/cf-conventions/tree/gh-pages). The gh-pages branch is deployed to github pages at the following documents: -- http://cfconventions.org/cf-conventions/cf-conventions.html -- http://cfconventions.org/cf-conventions/cf-conventions.pdf -- http://cfconventions.org/cf-conventions/conformance.html -- http://cfconventions.org/cf-conventions/conformance.pdf - -These documents are linked in the cf-conventions web site. [source here](https://github.com/cf-convention/cf-convention.github.io) which is published to: http://cfconventions.org/. The latest spec documents are linked from those web pages here: http://cfconventions.org/latest.html. \ No newline at end of file +This is new content!