From 0de641c3ccb0a72ca045a8c944d75640f7ffe895 Mon Sep 17 00:00:00 2001 From: mattmoore Date: Mon, 14 Oct 2013 15:40:07 -0400 Subject: [PATCH] Ignore the docs folder, updated readme --- .gitignore | 1 + README.md | 12 +++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ac3ba00 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/docs/* diff --git a/README.md b/README.md index 4144713..49402f9 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Create dynamic, well-formatted HTML5 markup with a simple an intuitive PHP API. This is a fork/rewrite of the [Gagawa](https://code.google.com/p/gagawa/) project. CanteenHTML5 is a concise, flexible and easy to remember API which makes it possible to create simple markup (such as a link) or more complex structures (such a table, document or nested list). All tags and attribute names are validated against the current HTML5 specification. +For documentation of the codebase, please see [Canteen HTML5 docs](http://canteen.github.io/CanteenHTML5/); + ##Requirements @@ -224,8 +226,16 @@ $table = new Table( ); ``` +###Rebuild Documentation + +This library is auto-documented using [YUIDoc](http://yui.github.io/yuidoc/). To install YUIDoc, run `sudo npm install yuidocjs`. Also, this requires the project [CanteenTheme](http://github.com/Canteen/CanteenTheme) be checked-out along-side this repository. To rebuild the docs, run the ant task from the command-line. + +```bash +ant docs +``` + ##License## -Copyright (c) 2013 Matt Karl and [CloudKid, LLC](http://cloudkid.com) +Copyright (c) 2013 [Matt Karl](http://github.com/bigtimebuddy) Released under the MIT License. \ No newline at end of file