Skip to content
Browse files

convert readme to markdown adn add credit and license info

  • Loading branch information...
1 parent 836a5ea commit 719af2c7d5e79aec9d8d1047edf70ef16a83da7f Chad Pytel committed
Showing with 62 additions and 26 deletions.
  1. +21 −0 LICENSE
  2. +41 −26 README.textile → README.md
View
21 LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Mike Burns
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
67 README.textile → README.md
@@ -1,18 +1,20 @@
-h1. Flutie
+Flutie
+======
Basic, default styles for rails applications
-h2. Installation & Upgrading
+Installation & Upgrading
+------------------------
Flutie is a Rails engine. It works with versions of Rails greater than 3.0.
Flutie is recommended to be run as a gem and included in your Gemfile:
-bc. gem "flutie", "~> 1.1"
+ gem "flutie", "~> 1.1"
After you've bundled, run the installer:
-bc. rake flutie:install
+ rake flutie:install
The installer will copy the Flutie stylesheets into public/flutie/stylesheets
@@ -22,7 +24,8 @@ Click on the "Default styles" link to view the same markup with a barebones layo
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.
-h2. Usage
+Usage
+-----
Flutie registers a :flutie shortcut for stylesheets, so in your layout you can do...
@@ -30,48 +33,60 @@ bc. <%= stylesheet_link_tag :flutie, 'admin', :cache => true %>
...this will include all the flutie stylesheets, then the 'admin' stylesheet, and it will cache them all into one file.
-h3. Sass
+### Sass
If you use Sass in your application, the flutie stylesheets are also available as scss files, installed in public/flutie/sass. This location is automatically added to your Sass template load path. These files can be imported into your own sass files for use with the following:
-bc. @import "flutie";
+ @import "flutie";
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.
-h3. Custom Styles
+### Custom Styles
To add custom styles to the styleguide add partials to the app/views/styleguides directory. For example:
-app/views/styleguides/_todo_item.erb:
+ app/views/styleguides/_todo_item.erb:
-bc.. <ol>
- <li class="todo">This is a todo item</li>
-</ol>
+ <ol>
+ <li class="todo">This is a todo item</li>
+ </ol>
-p. Plugin authors can also add to the styleguide by ensuring that their view path
+Plugin authors can also add to the styleguide by ensuring that their view path
is in ActionController::Base.view_paths and by placing a partial under the
styleguides directory. For example:
-bc. ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'views'))
+ ActionController::Base.append_view_path(File.join(File.dirname(__FILE__), 'views'))
-bc. my_awesome_plugin/views/styleguides/_pagination.erb:
+ my_awesome_plugin/views/styleguides/_pagination.erb:
-bc.. <div class="pagination">
- <a href="#prev">Previous</a>
- <a href="#next">Next</a>
-</div>
+ <div class="pagination">
+ <a href="#prev">Previous</a>
+ <a href="#next">Next</a>
+ </div>
-h2. Authors
-
-Flutie was written by thoughtbot, inc.
-
-h2. Suggestions, Bugs, Refactoring?
+Suggestions, Bugs, Refactoring?
+-------------------------------
Fork away and create a "Github Issue":http://github.com/thoughtbot/flutie/issues. Please don't send pull requests.
-h2. Development
+Development
+-----------
The actual stylesheet source files are sass, so edit the files in public/stylesheets/sass.
To rebuild the normal scss run:
-bc. sass -C --update public/stylesheets/sass:public/stylesheets
+ sass -C --update public/stylesheets/sass:public/stylesheets
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+Flutie is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
+
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+License
+-------
+
+Flutie is Copyright © 2010-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.

0 comments on commit 719af2c

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