aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails/generators/rails/model/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails/generators/rails/model/USAGE')
-rw-r--r--railties/lib/rails/generators/rails/model/USAGE30
1 files changed, 30 insertions, 0 deletions
diff --git a/railties/lib/rails/generators/rails/model/USAGE b/railties/lib/rails/generators/rails/model/USAGE
new file mode 100644
index 0000000000..d97e9ac103
--- /dev/null
+++ b/railties/lib/rails/generators/rails/model/USAGE
@@ -0,0 +1,30 @@
+Description:
+ Stubs out a new model. Pass the model name, either CamelCased or
+ under_scored, and an optional list of attribute pairs as arguments.
+
+ 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 model immediately.
+
+ This generator invokes your configured ORM and test framework, which
+ defaults to ActiveRecord and TestUnit.
+
+ Finally, if --parent option is given, it's used as superclass of the
+ created model. This allows you create Single Table Inheritance models.
+
+Examples:
+ `rails generate model account`
+
+ For ActiveRecord and TestUnit it creates:
+
+ Model: app/models/account.rb
+ Test: test/unit/account_test.rb
+ Fixtures: test/fixtures/accounts.yml
+ Migration: db/migrate/XXX_add_accounts.rb
+
+ `rails generate model post title:string body:text published:boolean`
+
+ Creates a Post model with a string title, text body, and published flag.