Skip to content
Browse files

correct/clarify Rails 3 and 3.1 usage

  • Loading branch information...
1 parent 4b37b89 commit d8b0f98c76f90dbe4f14114986c2fe50671b3ad9 Chad Pytel committed
Showing with 16 additions and 18 deletions.
  1. +16 −18 README.md
View
34 README.md
@@ -5,6 +5,8 @@ Flutie
Basic, default styles for rails applications
+We also have a [Bourbon](https://github.com/thoughtbot/bourbon) gem available, which can be used to extend flutie with a set of vanilla sass mixins.
+
Installation & Upgrading
------------------------
@@ -14,30 +16,27 @@ Flutie is recommended to be run as a gem and included in your Gemfile:
gem "flutie"
-After you've bundled, if you are using Rails < 3.1, run the installer:
+### Rails 3.1
- rake flutie:install
-
-The installer will copy the Flutie stylesheets sass into public/stylesheets/sass/flutie, and a static flutie.css into public/stylesheets/ in your app.
+After you've bundled, if you are using rails 3.1 or greater with asset pipelining enabled, simply add:
-Once Flutie is installed, with your application running (not in production environment) you can browse to /styleguides. This will present you with many standard markup elements that are present in a Rails application, in your default application layout.
+ @import 'flutie';
-Click on the "Default styles" link to view the same markup with a barebones layout that only contains the Flutie stylesheets. Click on "Application styles" to view the markup in your application layout.
+as a sass import in the application stylesheet manifest (app/assets/stylesheets/application.css).
-To upgrade, bump the gem version in your Gemfile, and then run 'rake flutie:install' again to get the latest changes moved into your application.
+### Rails 3
-If you are using rails 3.1 or greater with asset pipelining enabled, you don't need to run the installer. Simply add:
+After you've bundled, run the installer:
- *= require _flutie
+ rake flutie:install
-in the application stylesheet manifest (app/assets/stylesheets/application.css), or:
+The installer will copy the Flutie stylesheets sass into public/stylesheets/sass/flutie, and a static flutie.css into public/stylesheets/ in your app.
- @import 'flutie';
+Once Flutie is installed, with your application running (not in production environment) you can browse to /styleguides. This will present you with many standard markup elements that are present in a Rails application, in your default application layout.
-as a sass import.
+Click on the "Default styles" link to view the same markup with a barebones layout that only contains the Flutie stylesheets. Click on "Application styles" to view the markup in your application layout.
-Usage
------
+To upgrade, bump the gem version in your Gemfile, and then run 'rake flutie:install' again to get the latest changes moved into your application.
Flutie registers a :flutie shortcut for stylesheets, so in your layout you can do...
@@ -45,7 +44,7 @@ Flutie registers a :flutie shortcut for stylesheets, so in your layout you can d
...this will include all the flutie stylesheets, then the 'admin' stylesheet, and it will cache them all into one file.
-### Sass
+#### Sass
If you use Sass in your application, the flutie stylesheets are also available as scss files, installed in public/stylesheets/sass/flutie. These files can be imported into your own sass files for use with the following:
@@ -53,9 +52,8 @@ If you use Sass in your application, the flutie stylesheets are also available a
You'll want to import flutie before any of your own styles so that you can do things like extend your classes with flutie classes.
-We also have a [Bourbon](https://github.com/thoughtbot/bourbon) gem available, which can be used to extend flutie with a set of vanilla sass mixins.
-
-### Custom Styles
+Custom Styles
+-------------
To add custom styles to the styleguide add partials to the app/views/styleguides directory. For example:

0 comments on commit d8b0f98

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