[CB-590] Update README.md

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.7.0
• Fix Version/s: 2.0.0
• Assignee: Michael William Brooks
• Reporter: Anis Kadri
• Created: 26/Apr/12 22:20
• Updated: 23/Aug/18 06:45
• Resolved: 17/Jul/12 15:39

Description

The README.md in the Generating documentation section asks to install markdown via:

port install markdown

markdown does not exist in the macports

sudo port install markdown
Error: Port markdown not found
To report a bug, see <http://guide.macports.org/#project.tickets>

After installing Markdown.pl from here and putting it my PATH I get this exception when I run ./bin/generate

 => Generating the Cordova Documentation for 0.9.2-en...
./bin/../lib/cordova/navigation_menu.rb:14:in `read': can't convert nil into String (TypeError)
	from ./bin/../lib/cordova/navigation_menu.rb:14:in `initialize'
	from ./bin/../lib/docs_generator.rb:86:in `new'
	from ./bin/../lib/docs_generator.rb:86:in `after_jodoc'
	from ./bin/../lib/docs_generator.rb:55:in `run'
	from ./bin/../lib/docs_generator.rb:45:in `foreach'
	from ./bin/../lib/docs_generator.rb:45:in `run'
	from ./bin/../lib/docs_generator.rb:41:in `foreach'
	from ./bin/../lib/docs_generator.rb:41:in `run'
	from ./bin/generate:6

I fixed this by adding this line to my joDoc perl script

$markdown_bin = "/path/to/Markdown.pl";