Permalink
Browse files

Update readme a bit

  • Loading branch information...
berg committed Sep 5, 2013
1 parent c6de6ea commit b4e25cb2d54821b9af5e0c54b623cd92fb97d883
Showing with 9 additions and 11 deletions.
  1. +9 −11 README.md
View
@@ -2,31 +2,29 @@
This branch (new-docs) of the appdotnet/api-spec repo contains the source for [developers.app.net](http://developers.app.net/) and replaces the docs located on the master branch.
-This documentation can be compiled using [nanoc](http://nanoc.stoneship.org/).
+This documentation can be compiled using [nanoc](http://nanoc.stoneship.org/).
All submissions are welcome. To submit a change, fork this repo, commit your changes, and send us a [pull request](http://help.github.com/send-pull-requests/).
## Building the docs
-Ruby 1.9 is required to build the site.
+Ruby is required to build the site.
-To install nanoc and make sure you have all the necessary ruby gems, open a terminal and run
+To install nanoc and make sure you have all the necessary ruby gems, open a terminal in the root of the api-spec checkout and run
$ bundle install
-To compile the docs, run
+To compile the docs for the first time, run
- $ nanoc
+ $ bundle exec nanoc
Nanoc compiles the site into static files living in `./output`.
-Once the docs are compiled, you can view the result using the adsf web server which is part of the install bundle:
+In general, the best way to work on the docs is like this:
- $ nanoc view
- $ open http://localhost:3000
+ $ bundle exec nanoc view &
+ $ bundle exec guard start
-If you want to have nanoc autocompile your changes, run
-
- $ nanoc watch
+Guard will run and auto-generate new HTML output when you edit Markdown files, and the nanoc built-in webserver will be available on http://localhost:3000/
If you want to learn more about using nanoc, view the [nanoc documentation](http://nanoc.stoneship.org/docs/1-introduction/).

0 comments on commit b4e25cb

Please sign in to comment.