Browse Source

Updating the readme to include info aboutrunning the docs locally.

pull/220/head
connors 11 years ago
parent
commit
b3400ca7ee
  1. 12
      README.md

12
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).

Loading…
Cancel
Save