From b3400ca7ee5594b86d485489bdefc0bd692a2523 Mon Sep 17 00:00:00 2001 From: connors Date: Sat, 5 Oct 2013 17:23:35 -0700 Subject: [PATCH] Updating the readme to include info aboutrunning the docs locally. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4d2e8c8..29a405a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,18 @@ Prototype mobile apps with simple HTML, CSS and JS components. Take note that our master branch is our active, unstable development branch and that if you're looking to download a stable copy of the repo, check the [tagged downloads](https://github.com/maker/ratchet/tags). +## Documentation + +Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://maker.github.com/ratchet](http://maker.github.com/ratchet). The docs may also be run locally. + +### Running documentation locally + +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation). +2. From the root `/ratchet` directory, run `jekyll serve` in the command line. +3. Open [http://localhost:4000](http://localhost:4000) in your browser, and boom! + +Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). + ## Support Ratchet was developed to support iOS 7+ for iPhone. Questions or discussions about Ratchet should happen in the [Google group](https://groups.google.com/forum/#!forum/goratchet) or hit us up on Twitter [@goRatchet](http://www.twitter.com/goratchet).