aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/generators/rails/scaffold_controller/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails/generators/rails/scaffold_controller/USAGE')
-rw-r--r--railties/lib/rails/generators/rails/scaffold_controller/USAGE20
1 files changed, 20 insertions, 0 deletions
diff --git a/railties/lib/rails/generators/rails/scaffold_controller/USAGE b/railties/lib/rails/generators/rails/scaffold_controller/USAGE
new file mode 100644
index 0000000000..d60a3c3680
--- /dev/null
+++ b/railties/lib/rails/generators/rails/scaffold_controller/USAGE
@@ -0,0 +1,20 @@
+Description:
+ Stubs out a scaffolded controller and its views. Pass the model name,
+ either CamelCased or under_scored, and a list of views as arguments.
+ The controller name is retrieved as a pluralized version of the model
+ name.
+
+ To create a controller within a module, specify the model name as a
+ path like 'parent_module/controller_name'.
+
+ This generates a controller class in app/controllers and invokes helper,
+ template engine and test framework generators.
+
+Example:
+ `./script/generate scaffold_controller CreditCard`
+
+ Credit card controller with URLs like /credit_card/debit.
+ Controller: app/controllers/credit_cards_controller.rb
+ Functional Test: test/functional/credit_cards_controller_test.rb
+ Views: app/views/credit_cards/index.html.erb [...]
+ Helper: app/helpers/credit_cards_helper.rb