Merge pull request #22068 from y-yagi/change_default_to_markdown

README.rdoc -> README.md for newly generated plugins

railties/CHANGELOG.md

@@ -1,3 +1,7 @@
+*   Newly generated plugins get a `README.md` in Markdown.
+
+    *Yuji Yaginuma*
+
 *   The generated config file for the development environment includes a new
     config line, commented out, showing how to enable the evented file watcher.
 

railties/lib/rails/generators/rails/plugin/plugin_generator.rb

@@ -37,7 +37,7 @@ def app
     end
 
     def readme
-      template "README.rdoc"
+      template "README.md"
     end
 
     def gemfile

railties/lib/rails/generators/rails/plugin/templates/%name%.gemspec

@@ -14,7 +14,7 @@
   s.description = "TODO: Description of <%= camelized_modules %>."
   s.license     = "MIT"
 
-  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.md"]
 
   <%= '# ' if options.dev? || options.edge? -%>s.add_dependency "rails", "~> <%= Rails::VERSION::STRING %>"
 <% unless  options[:skip_active_record] -%>

railties/lib/rails/generators/rails/plugin/templates/README.md

@@ -0,0 +1,3 @@
+# <%= camelized_modules %>
+
+This project rocks and uses MIT-LICENSE.

railties/lib/rails/generators/rails/plugin/templates/README.rdoc

@@ -1,3 +0,0 @@
-= <%= camelized_modules %>
-
-This project rocks and uses MIT-LICENSE.

railties/lib/rails/generators/rails/plugin/templates/Rakefile

@@ -10,7 +10,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = '<%= camelized_modules %>'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

railties/test/generators/plugin_generator_test.rb

@@ -6,7 +6,7 @@
   .gitignore
   Gemfile
   Rakefile
-  README.rdoc
+  README.md
   bukkits.gemspec
   MIT-LICENSE
   lib
@@ -58,7 +58,7 @@ def test_correct_file_in_lib_folder_of_camelcase_plugin_name
 
   def test_generating_without_options
     run_generator
-    assert_file "README.rdoc", /Bukkits/
+    assert_file "README.md", /Bukkits/
     assert_no_file "config/routes.rb"
     assert_no_file "app/assets/config/bukkits_manifest.js"
     assert_file "test/test_helper.rb" do |content|
@@ -386,7 +386,7 @@ def test_create_mountable_application_with_mountable_option_and_multiple_hypenat
   def test_creating_gemspec
     run_generator
     assert_file "bukkits.gemspec", /s.name\s+= "bukkits"/
-    assert_file "bukkits.gemspec", /s.files = Dir\["\{app,config,db,lib\}\/\*\*\/\*", "MIT-LICENSE", "Rakefile", "README\.rdoc"\]/
+    assert_file "bukkits.gemspec", /s.files = Dir\["\{app,config,db,lib\}\/\*\*\/\*", "MIT-LICENSE", "Rakefile", "README\.md"\]/
     assert_file "bukkits.gemspec", /s.version\s+ = Bukkits::VERSION/
   end