From 3cadb96224db0bdee8bdb78cefc97158f7b7260f Mon Sep 17 00:00:00 2001 From: "James 'J.C.' Jones" Date: Thu, 7 Apr 2016 12:04:49 -0700 Subject: [PATCH] Add build, installation, contact, and branch information to the README.md (#67) --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4bef3c5fe..1ea9fee96 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,36 @@ -# Specification 'webauthn' +# Web Authentication Specification + +This is the repository for the W3C WebAuthn Working Group, producing the draft **"Web Authentication"** + +* [The editor's copy is available at https://w3c.github.io/webauthn/](https://w3c.github.io/webauthn/), or in the [`gh-pages` branch of this repository](https://github.com/w3c/webauthn/blob/gh-pages/index.html). +* [The build history is available at Travis-CI.org](https://travis-ci.org/w3c/webauthn/builds) +* [W3C WebAuthn Blog](https://www.w3.org/blog/webauthn/) + +# Contributing + +Before submitting feedback, please familiarize yourself with [our current issues list](https://github.com/w3c/webauthn/issues) and review the [mailing list discussion](https://lists.w3.org/Archives/Public/public-webauthn/). + +# Building the Draft + +Formatted HTML for the draft can be built using `make` or `gmake`: + +``` +$ make +``` + +# Installation and Setup + +You will need to have the Python tools `pygments` and `bikeshed` to build the draft. Pygments can be obtained via `pip`, but Bikeshed will need to be downloaded with `git`: + +``` +git clone --depth=1 --branch=master https://github.com/tabatkins/bikeshed.git ./bikeshed +pip install pygments +pip install --editable ./bikeshed +bikeshed update +```` + +# Continuous Integration & Branches + +This repository uses a [variation](https://github.com/jcjones/bikeshed-template) on [martinthomson/i-d-template](https://github.com/martinthomson/i-d-template) to generate the Editor's Draft on the `gh-pages` branch upon every merge to `master`. In order to prevent failed merges during continuous integration, the formatted Editor's Draft should not be checked in to `master`, and it is in the `.gitignore` file. -This is the repository for webauthn. You're welcome to contribute! Let's make the Web rock our socks -off!