You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/09/19 16:32:07 UTC
docs commit: Update README.md for simpler install instructions.
Updated Branches:
refs/heads/master 348bc004d -> 2bb27cfb9
Update README.md for simpler install instructions.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/2bb27cfb
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/2bb27cfb
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/2bb27cfb
Branch: refs/heads/master
Commit: 2bb27cfb9c7f36dc01ea1c1ae415df097dc8d47d
Parents: 348bc00
Author: Michael Brooks <mi...@michaelbrooks.ca>
Authored: Thu Sep 19 16:32:02 2013 +0200
Committer: Michael Brooks <mi...@michaelbrooks.ca>
Committed: Thu Sep 19 16:32:02 2013 +0200
----------------------------------------------------------------------
README.md | 38 ++++++++++++++++++--------------------
1 file changed, 18 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/2bb27cfb/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index b9aca82..81a3cea 100644
--- a/README.md
+++ b/README.md
@@ -97,15 +97,7 @@ Please see the `STYLESHEET.md` file for guildelines on language and usage.
Generating the Documentation
----------------------------
-### Quick Preview
-
-When making minor edits, it is usually safe to simply render the edited from
-Markdown to HTML. Many code editors have plugins to render Markdown to HTML
-and there are a handful of [good](http://dillinger.io/) online editors.
-
-Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc) are used to generate the HTML documentation.
-
-### Install joDoc
+### Install
- Clone [joDoc](http://github.com/davebalmer/jodoc)
@@ -119,30 +111,36 @@ Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc) are use
- Install markdown
- # Use your package manager
+ # OS X
brew install markdown
-on Linux, Markdown can be installed as follows:
-
+ # Linux
apt-get install markdown
-- Install nokogiri (Ruby HTML parser)
+- Install Ruby gems
- gem install nokogiri
+ Install [bundler](http://bundler.io/#getting-started) then
-- Install json (Ruby JSON parser)
-
- gem install json
+ bundle install
### Run the Script
+Generate all versions
+
bin/generate
-If all you want to generate is edge/English, then
+Generate a specific language and version
+
+ bin/generate en edge
+
+### Quick Preview
- bin/generate --edge
+When making minor edits, it is usually safe to simply render the edited from
+Markdown to HTML. Many code editors have plugins to render Markdown to HTML
+and there are a handful of [good](http://dillinger.io/) online editors.
-### Problems
+Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc) are
+used to generate the HTML documentation.
Generated a Version Release
---------------------------