summaryrefslogtreecommitdiff
path: root/lib/generators/nifty/layout/USAGE
diff options
context:
space:
mode:
Diffstat (limited to 'lib/generators/nifty/layout/USAGE')
-rw-r--r--lib/generators/nifty/layout/USAGE25
1 files changed, 25 insertions, 0 deletions
diff --git a/lib/generators/nifty/layout/USAGE b/lib/generators/nifty/layout/USAGE
new file mode 100644
index 0000000..f94af0d
--- /dev/null
+++ b/lib/generators/nifty/layout/USAGE
@@ -0,0 +1,25 @@
+Description:
+ The nifty_layout generator creates a basic layout, stylesheet and
+ helper which will give some structure to a starting Rails app.
+
+ The generator takes one argument which will be the name of the
+ layout and stylesheet files. If no argument is passed then it defaults
+ to "application".
+
+ The helper module includes some methods which can be called in any
+ template or partial to set variables to be used in the layout, such as
+ page title and javascript/stylesheet includes.
+
+Examples:
+ rails generate nifty:layout
+
+ Layout: app/views/layouts/application.html.erb
+ Stylesheet: public/stylesheets/application.css
+ Helper: app/helpers/layout_helper.rb
+
+
+ rails generate nifty:layout admin
+
+ Layout: app/views/layouts/admin.html.erb
+ Stylesheet: public/stylesheets/admin.css
+ Helper: app/helpers/layout_helper.rb