ruby-on-railsrdocreadme

When does Rails generate a readme.md (as opposed to a readme.rdoc)?

I noticed that when I generate a new rails app sometimes I end up with a readme.md and sometimes with a readme.rdoc (which Bitbucket doesnt automatically render apparentely).

If you've got any ideas about that, please let me know.

Solution

  • Running rails new with Rails 4 (or Rails 3) generates README.rdoc, while running it with Rails 5 creates README.md.

    This is listed in the notable changes section of the Rails 5.0 release notes:

    • Newly generated applications and plugins get a README.md in Markdown. (commit, Pull Request)