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

fxn · fxn · commit 89a12c931b1f · 2015-02-06T21:04:54.000+01:00
README.rdoc was generated to support the doc:app task. Now that
this task is gone we can switch to Markdown, which is nowadays
a better default.
diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md
@@ -1,3 +1,7 @@
+*   Newly generated applications get a `README.md` in Markdown.
+
+    *Xavier Noria*
+
 *   Remove the documentation tasks `doc:app`, `doc:rails`, and `doc:guides`.
 
     *Xavier Noria*
diff --git a/railties/lib/rails/generators/rails/app/app_generator.rb b/railties/lib/rails/generators/rails/app/app_generator.rb
@@ -38,7 +38,7 @@ def rakefile
     end
 
     def readme
-      copy_file "README.rdoc", "README.rdoc"
+      copy_file "README.md", "README.md"
     end
 
     def gemfile
diff --git a/railties/lib/rails/generators/rails/app/templates/README.md b/railties/lib/rails/generators/rails/app/templates/README.md
@@ -1,4 +1,4 @@
-== README
+## README
 
 This README would normally document whatever steps are necessary to get the
 application up and running.
diff --git a/railties/test/generators/actions_test.rb b/railties/test/generators/actions_test.rb
@@ -222,14 +222,14 @@ def test_route_should_add_data_to_the_routes_block_in_config_routes
   def test_readme
     run_generator
     Rails::Generators::AppGenerator.expects(:source_root).times(2).returns(destination_root)
-    assert_match "application up and running", action(:readme, "README.rdoc")
+    assert_match "application up and running", action(:readme, "README.md")
   end
 
   def test_readme_with_quiet
     generator(default_arguments, quiet: true)
     run_generator
     Rails::Generators::AppGenerator.expects(:source_root).times(2).returns(destination_root)
-    assert_no_match "application up and running", action(:readme, "README.rdoc")
+    assert_no_match "application up and running", action(:readme, "README.md")
   end
 
   def test_log
diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb
@@ -5,7 +5,7 @@
 
 DEFAULT_APP_FILES = %w(
   .gitignore
-  README.rdoc
+  README.md
   Gemfile
   Rakefile
   config.ru

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-== README`
	`1`	`+## README`
`2`	`2`
`3`	`3`	`This README would normally document whatever steps are necessary to get the`
`4`	`4`	`application up and running.`