diff options
| author | Xavier Noria <fxn@hashref.com> | 2015-02-06 20:41:42 +0100 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2015-02-06 21:04:54 +0100 |
| commit | 89a12c931b1f00b90e74afffcdc2fc21f14ca663 (patch) | |
| tree | 3f1ea4ff032373680cea876a8c56524e0d5f6f3b /railties | |
| parent | cd7cc5254b090ccbb84dcee4408a5acede25ef2a (diff) | |
| download | rails-89a12c931b1f00b90e74afffcdc2fc21f14ca663.tar.gz rails-89a12c931b1f00b90e74afffcdc2fc21f14ca663.tar.bz2 rails-89a12c931b1f00b90e74afffcdc2fc21f14ca663.zip | |
README.rdoc -> README.md for newly generated applications
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.
Diffstat (limited to 'railties')
| -rw-r--r-- | railties/CHANGELOG.md | 4 | ||||
| -rw-r--r-- | railties/lib/rails/generators/rails/app/app_generator.rb | 2 | ||||
| -rw-r--r-- | railties/lib/rails/generators/rails/app/templates/README.md (renamed from railties/lib/rails/generators/rails/app/templates/README.rdoc) | 2 | ||||
| -rw-r--r-- | railties/test/generators/actions_test.rb | 4 | ||||
| -rw-r--r-- | railties/test/generators/app_generator_test.rb | 2 |
5 files changed, 9 insertions, 5 deletions
diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md index 8c536982fc..f88e6242c0 100644 --- 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 index b6e6642f11..977f5a1c03 100644 --- a/railties/lib/rails/generators/rails/app/app_generator.rb +++ b/railties/lib/rails/generators/rails/app/app_generator.rb @@ -38,7 +38,7 @@ module Rails 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.rdoc b/railties/lib/rails/generators/rails/app/templates/README.md index db0fbe031b..55e144da18 100644 --- a/railties/lib/rails/generators/rails/app/templates/README.rdoc +++ 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 index c4b6441397..c6de2c1fb9 100644 --- a/railties/test/generators/actions_test.rb +++ b/railties/test/generators/actions_test.rb @@ -222,14 +222,14 @@ class ActionsTest < Rails::Generators::TestCase 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 index 8cef40b151..ca26e0c8d7 100644 --- a/railties/test/generators/app_generator_test.rb +++ b/railties/test/generators/app_generator_test.rb @@ -5,7 +5,7 @@ require 'mocha/setup' # FIXME: stop using mocha DEFAULT_APP_FILES = %w( .gitignore - README.rdoc + README.md Gemfile Rakefile config.ru |