Standard ruby on rails project has README.rdoc. Many github rails projects have README.md.
What is the difference?
ruby github markdown
------------------------------------------------------------------------------------------------------------------------------------------------------------------
------------------------------------------------------------------------------------------------------------------------------------------------------------------
Answers;
RDoc is a fantastic tool which enables the automatic generation of formatted HTML containing our documented code.For example, most of gems on RubyGems fetch documentation and compiles them to give the resultant rdoc.
If your project doesn't have README.md, GitHub may parse README.rdoc to display details. If it has both, it will use README.md, silently ignoring rdoc. I usually have both, README.md for Github, and README.rdoc for RDoc documentation on RubyGems.
No comments:
Post a Comment