Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshaven committed Sep 28, 2009
1 parent 91170c9 commit 7cbb3f0
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.rdoc
Expand Up @@ -20,9 +20,28 @@ and I'll be happy to incorporate your changes.


== Installation

git clone git://github.com/joshaven/RDoc.tmbundle.git ~/Library/Application\ Support/TextMate/Bundles/RDoc.tmbundle


You will want to run the following line to reload the bundles if TextMate was open during the install...
osascript -e 'tell app "TextMate" to reload bundles'


Optional... If you would like to launch your rdocs from any .rb file in your project, try this out.

* Edit the bundles within TextMate Ctrl+Opt+CMD+b
* Choose the "Run" command from the "Ruby" bundle and click the copy button (double plus sign)
* Type "Preview" to rename what is currently called "Run copy"
* Replace the context with the following in the text area on the right labeled: Command(s)

#!/bin/bash --posix
rake rdoc
osascript -e "tell application \"Safari\" to open location \"file:///$TM_PROJECT_DIRECTORY/rdoc/index.html\""

* Click on the Action Key Equivalent setting section and set as Ctrl+Opt+CMD+p
* Close the bundle editor and choose Bundles > Bundle Editor > Reload Bundles
* Enjoy the fast access to a rdoc view of your current file. Pressing Ctrl+Opt+CMD+p will regenerate the rdocs then
load them in Safari


== Copyright

Expand Down

0 comments on commit 7cbb3f0

Please sign in to comment.