search

SciRuby / sciruby

Tools for scientific computation in Ruby
http://gems.sciruby.com
Other
994 stars 80 forks source link

cleaned up the formatting of the readme for rdoc compliance #18

Closed matthewrobertson closed 12 years ago

matthewrobertson commented 12 years ago

I reformatted the README file so that it is all in proper RDOC formatting. I also changed the extension so that it will be rendered as html on the github home page.

The only thing that is not perfect is the image link to the pledgy page. I got the image up but I couldn't sort out how to make it a link. For now the link is below the image...

translunar commented 12 years ago

Hey, thanks for the pull request.

A quick question. We just reverted from an rdoc to a txt file, mainly because Darkfish was having trouble parsing an rdoc. Can you confirm that rake test and rake docs work properly with this patch? If so, what were we doing wrong?

matthewrobertson commented 12 years ago

Yep you were right it wasn't working. I had to do 3 things:

  1. update a couple references to README.txt in the gemspec and Manifest
  2. configure Hoe to look for README.rdoc not README.txt (README.txt is what it looks for by default)
  3. explicitly tell rdoc to include the README.rdoc before setting it to main

As of my most recent commit bundle exec rake docs works like a charm

translunar commented 12 years ago

Thanks again. I was able to get the image donation links to work, too.