svn commit: r1447985 - /cordova/site/README.md

[mw...@apache.org]

Author: mwbrooks
Date: Wed Feb 20 01:27:57 2013
New Revision: 1447985

URL: http://svn.apache.org/r1447985
Log:
Update README.md with Getting Started instructions.

Modified:
    cordova/site/README.md

Modified: cordova/site/README.md
URL: http://svn.apache.org/viewvc/cordova/site/README.md?rev=1447985&r1=1447984&r2=1447985&view=diff
==============================================================================
--- cordova/site/README.md (original)
+++ cordova/site/README.md Wed Feb 20 01:27:57 2013
@@ -1,38 +1,62 @@
 Cordova Website
-==========================
+===============
 
 
 Dependencies
------------------------
+------------
 
 - Mustache for Ruby
 - LessCSS
-- Json
+- JSON
 - See `Gemfile` for more details, and below on how to install these.
 
+Get the source code
+-------------------
+
+    $ svn checkout https://svn.apache.org/repos/asf/cordova/site cordova-website
+
 
 How to compile the site
 -----------------------
 
-- from commandline, set `cd` to your `cordova-website` repo directory.
-- run `sudo gem install bundler` if bundler isn't already installed.
-- run `sudo bundle install` (only the first time, or whenever the Gemfile is
-  updated).
-- run `rake build` to generate the site.
-- the site will be generated in `public` folder with an index.html file which 
-  you can open as a local file in your browser.
+    # change to the cordova website directory.
+    $ cd /path/to/cordova-website
 
+    # install bundler if it isn't already installed.
+    $ sudo gem install bundler
 
-Updating the docs
------------------------
+    # update project gems.
+    # only the first time or when the Gemfile is updated.
+    $ sudo bundle install
+
+    # compile the site.
+    $ rake build
+
+    # the site is generated in `public/` with an index.html file that
+    # can be opened as a local file in your browser.
+    $ open public/index.html
 
-- render the docs following the directions under the `cordova-docs` repository.
-- copy the rendered docs from (`cordova-docs/public/`) to `public/docs`.
-- commit your changes.
+
+How to updating the docs
+------------------------
+
+    # render the docs following the directions in the `cordova-docs` repository.
+    $ cd /path/to/cordova-docs
+    $ ./bin/generate
+
+    # copy the rendered docs from `cordova-docs` to `cordova-website`
+    $ rm -r /path/to/cordova-website/public/docs
+    $ cp -r /path/to/cordova-docs/public/ /path/to/cordova-website/public/docs
+
+    # no need to compile the site, since the docs are in the public directory.
+
+    # commit your changes to SVN
+    $ svn add public/docs/
+    $ svn commit -m "Add docs version 2.5.0."
 
 
 Things you should know
------------------------
+----------------------
 
 - `bin/config.json` + `www/template.html` + Mustache outputs `index.html`
 - `bin/config.json` contains information for: download & archives, quick links, and list of repos