aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/generators/rails/scaffold/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/generators/rails/scaffold/USAGE')
-rw-r--r--railties/lib/generators/rails/scaffold/USAGE29
1 files changed, 29 insertions, 0 deletions
diff --git a/railties/lib/generators/rails/scaffold/USAGE b/railties/lib/generators/rails/scaffold/USAGE
new file mode 100644
index 0000000000..71edd2f469
--- /dev/null
+++ b/railties/lib/generators/rails/scaffold/USAGE
@@ -0,0 +1,29 @@
+Description:
+ Scaffolds an entire resource, from model and migration to controller and
+ views, along with a full test suite. The resource is ready to use as a
+ starting point for your RESTful, resource-oriented application.
+
+ Pass the name of the model (in singular form), either CamelCased or
+ under_scored, as the first argument, and an optional list of attribute
+ pairs.
+
+ Attribute pairs are field:type arguments specifying the
+ model's attributes. Timestamps are added by default, so you don't have to
+ specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+ You don't have to think up every attribute up front, but it helps to
+ sketch out a few so you can start working with the resource immediately.
+
+ For example, 'scaffold post title:string body:text published:boolean'
+ gives you a model with those three attributes, a controller that handles
+ the create/show/update/destroy, forms to create and edit your posts, and
+ an index that lists them all, as well as a map.resources :posts
+ declaration in config/routes.rb.
+
+ If you want to remove all the generated files, run
+ 'script/destroy scaffold ModelName'.
+
+Examples:
+ `./script/generate scaffold post`
+ `./script/generate scaffold post title:string body:text published:boolean`
+ `./script/generate scaffold purchase order_id:integer amount:decimal`