Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Organize README

* Organized code status badges into a "Code Status" section.
* Moved the OSI MIT License link inline (bullets are for unordered
  lists).
* Removed all EOL whitespace.

[ci skip]
  • Loading branch information...
commit c195aede73228125833d4e848c6035f2799553c1 1 parent 59a53f4
Vinny Diehl authored October 26, 2012

Showing 2 changed files with 18 additions and 19 deletions. Show diff stats Hide diff stats

  1. 29  README.rdoc
  2. 8  Rakefile
29  README.rdoc
Source Rendered
@@ -6,29 +6,29 @@ database-backed web applications according to the {Model-View-Controller (MVC)}[
6 6
 Understanding the MVC pattern is key to understanding Rails. MVC divides your application
7 7
 into three layers, each with a specific responsibility.
8 8
 
9  
-The View layer is composed of "templates" that are responsible for providing 
  9
+The View layer is composed of "templates" that are responsible for providing
10 10
 appropriate representations of your application's resources. Templates
11 11
 can come in a variety of formats, but most view templates are \HTML with embedded Ruby
12  
-code (.erb files). 
  12
+code (.erb files).
13 13
 
14  
-The Model layer represents your domain model (such as Account, Product, Person, Post) 
15  
-and encapsulates the business logic that is specific to your application. In Rails, 
  14
+The Model layer represents your domain model (such as Account, Product, Person, Post)
  15
+and encapsulates the business logic that is specific to your application. In Rails,
16 16
 database-backed model classes are derived from ActiveRecord::Base. Active Record allows
17  
-you to present the data from database rows as objects and embellish these data objects 
18  
-with business logic methods. Although most Rails models are backed by a database, models 
  17
+you to present the data from database rows as objects and embellish these data objects
  18
+with business logic methods. Although most Rails models are backed by a database, models
19 19
 can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as
20 20
 provided by the ActiveModel module. You can read more about Active Record in its
21 21
 {README}[link:/rails/rails/blob/master/activerecord/README.rdoc].
22 22
 
23  
-The Controller layer is responsible for handling incoming HTTP requests and providing a 
  23
+The Controller layer is responsible for handling incoming HTTP requests and providing a
24 24
 suitable response. Usually this means returning \HTML, but Rails controllers can also
25  
-generate XML, JSON, PDFs, mobile-specific views, and more. Controllers manipulate models 
  25
+generate XML, JSON, PDFs, mobile-specific views, and more. Controllers manipulate models
26 26
 and render view templates in order to generate the appropriate HTTP response.
27 27
 
28 28
 In Rails, the Controller and View layers are handled together by Action Pack.
29  
-These two layers are bundled in a single package due to their heavy interdependence. 
  29
+These two layers are bundled in a single package due to their heavy interdependence.
30 30
 This is unlike the relationship between Active Record and Action Pack which are
31  
-independent. Each of these packages can be used independently outside of Rails. You 
  31
+independent. Each of these packages can be used independently outside of Rails. You
32 32
 can read more about Action Pack in its {README}[link:/rails/rails/blob/master/actionpack/README.rdoc].
33 33
 
34 34
 == Getting Started
@@ -67,12 +67,11 @@ We encourage you to contribute to Ruby on Rails! Please check out the {Contribut
67 67
 guide}[http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html] for guidelines about how
68 68
 to proceed. {Join us}[http://contributors.rubyonrails.org]!
69 69
 
70  
-== Build Status {<img src="https://secure.travis-ci.org/rails/rails.png"/>}[http://travis-ci.org/rails/rails]
  70
+== Code Status
71 71
 
72  
-== Dependency Status {<img src="https://gemnasium.com/rails/rails.png?travis"/>}[https://gemnasium.com/rails/rails]
  72
+* {<img src="https://secure.travis-ci.org/rails/rails.png"/>}[http://travis-ci.org/rails/rails]
  73
+* {<img src="https://gemnasium.com/rails/rails.png?travis"/>}[https://gemnasium.com/rails/rails]
73 74
 
74 75
 == License
75 76
 
76  
-Ruby on Rails is released under the MIT license:
77  
-
78  
-* http://www.opensource.org/licenses/MIT
  77
+Ruby on Rails is released under the {MIT License}[http://www.opensource.org/licenses/MIT].
8  Rakefile
@@ -75,10 +75,10 @@ RDoc::Task.new do |rdoc|
75 75
     rdoc_main.gsub!(/^(?=\S).*?\b(?=Rails)\b/) { "#$&\\" }
76 76
     rdoc_main.gsub!(%r{link:/rails/rails/blob/master/(\w+)/README\.rdoc}, "link:files/\\1/README_rdoc.html")
77 77
 
78  
-    # Remove Travis and Gemnasium status images from API pages. Only GitHub
79  
-    # README page gets these images. Travis' https build image is used to avoid
80  
-    # GitHub caching: http://about.travis-ci.org/docs/user/status-images
81  
-    rdoc_main.gsub!(%r{^== (Build|Dependency) Status.*}, '')
  78
+    # Remove Travis and Gemnasium status images from API pages. Only the GitHub
  79
+    # README page gets these images. Travis's HTTPS build image is used to
  80
+    # avoid GitHub caching: http://about.travis-ci.org/docs/user/status-images
  81
+    rdoc_main.gsub!(/^== Code Status(\n(?!==).*)*/, '')
82 82
 
83 83
     File.open(RDOC_MAIN, 'w') do |f|
84 84
       f.write(rdoc_main)

0 notes on commit c195aed

Please sign in to comment.
Something went wrong with that request. Please try again.