You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/12/18 16:15:54 UTC
docs commit: Update .gitignore and README.md to not require sudo for
dependencies.
Updated Branches:
refs/heads/master 0ba031132 -> 03c24a41b
Update .gitignore and README.md to not require sudo for dependencies.
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/03c24a41
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/03c24a41
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/03c24a41
Branch: refs/heads/master
Commit: 03c24a41b3ff128174749c0aad277eba60fc429a
Parents: 0ba0311
Author: Andrew Grieve <ag...@cordova-vm.apache.org>
Authored: Wed Dec 18 01:45:06 2013 +0000
Committer: Andrew Grieve <ag...@cordova-vm.apache.org>
Committed: Wed Dec 18 01:45:06 2013 +0000
----------------------------------------------------------------------
.gitignore | 3 +++
Gemfile | 1 +
Gemfile.lock | 12 ------------
README.md | 33 ++++++++++++++-------------------
4 files changed, 18 insertions(+), 31 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03c24a41/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 9d3614a..22f942b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,3 +5,6 @@ release/
TAGS
,*
_*
+/joDoc/
+/markdown
+/Gemfile.lock
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03c24a41/Gemfile
----------------------------------------------------------------------
diff --git a/Gemfile b/Gemfile
index 8405800..3f9e3c5 100644
--- a/Gemfile
+++ b/Gemfile
@@ -19,4 +19,5 @@ source "https://rubygems.org"
ruby '1.8.7'
gem 'nokogiri', '1.5.9'
gem 'json'
+gem 'rspec', '1.3.0'
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03c24a41/Gemfile.lock
----------------------------------------------------------------------
diff --git a/Gemfile.lock b/Gemfile.lock
deleted file mode 100644
index 4e9a07e..0000000
--- a/Gemfile.lock
+++ /dev/null
@@ -1,12 +0,0 @@
-GEM
- remote: https://rubygems.org/
- specs:
- json (1.8.0)
- nokogiri (1.5.9)
-
-PLATFORMS
- ruby
-
-DEPENDENCIES
- json
- nokogiri (= 1.5.9)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/03c24a41/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 6921b1c..5af22d3 100644
--- a/README.md
+++ b/README.md
@@ -103,39 +103,34 @@ Generating the Documentation
git clone http://github.com/davebalmer/joDoc.git
-- Add joDoc/ to your path
-
- Open `~/.bashrc` or `~/.profile` (or whatever you use)
-
- export PATH=$PATH:~/path/to/joDoc/
-
- Install markdown
- # OS X
- brew install markdown
-
- # Linux
- apt-get install markdown
+ curl -O http://daringfireball.net/projects/downloads/Markdown_1.0.1.zip
+ unzip Markdown_1.0.1.zip
+ chmod u+x Markdown_1.0.1/Markdown.pl
+ mv Markdown_1.0.1/Markdown.pl markdown
+ rm -r Markdown_1*
-- Install Ruby gems
+- Install Ruby Dependencies
- Install [bundler](http://bundler.io/#getting-started) then
-
- bundle install
+ curl -sSL https://get.rvm.io | bash -s stable
+ rvm install 1.8.7
+ gem install bundler
+ bundle install
### Run the Script
Generate all versions
- bin/generate
+ PATH=$PATH:$PWD/joDoc:$PWD bin/generate
Generate a specific language and version
- bin/generate en edge
+ PATH=$PATH:$PWD/joDoc:$PWD bin/generate en edge
or as a shortcut
- bin/generate --edge
+ PATH=$PATH:$PWD/joDoc:$PWD bin/generate --edge
### Quick Preview
@@ -160,7 +155,7 @@ If while running rake you get the error
then run
- sudo gem install rspec -v 1.3.0
+ gem install rspec -v 1.3.0
FAQ
---