Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated readme to support new command line tools

  • Loading branch information...
commit 76fb0496cabea50042f301e85f63b2cbaa2fd4af 1 parent e44ce04
@plapier plapier authored
Showing with 34 additions and 44 deletions.
  1. +34 −44 readme.md
View
78 readme.md
@@ -1,8 +1,9 @@
[![Bourbon Sass Mixin Library](http://bourbon.io/images/bourbon-logo.png)](http://bourbon.io)
+
# A simple and lightweight mixin library for Sass
Bourbon is a comprehensive library of sass mixins that are designed to be simple
-and easy to use. No configuration required. The mixins aim to be as vanilla as
-possible, meaning they should be as close to the original CSS syntax as possible.
+and easy to use. No configuration required.
+The mixins aim to be as vanilla as possible, meaning they should be as close to the original CSS syntax as possible.
The mixins contain vendor specific prefixes for all CSS3 properties for support
amongst modern browsers. The prefixes also ensure graceful degradation for older
@@ -11,9 +12,9 @@ browsers that support only CSS3 prefixed properties. Bourbon uses SCSS syntax.
#[Documentation & Demo](http://bourbon.io)
# Requirements
-Sass 3.1+
+Sass 3.2+
-# Install for Rails
+# Install for Rails 3.1.x
In your Gemfile:
gem 'bourbon'
@@ -22,79 +23,63 @@ Then run:
$ bundle install
-## Rails 3.1.x
-Rename application.css to application.css.scss:
+Restart your server. Then rename application`.css` to application`.css.scss`:
mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss
-Bourbon needs the sass files to be imported in a specific order to function properly. Therefore, you will need to disable the require\_tree sprocket directive.
-Delete the following sprocket directive in application.css.scss:
+Delete the sprocket directive in application.css.scss: [Why?](https://github.com/thoughtbot/bourbon/wiki/Rails-Sprockets)
*= require_tree .
-Import bourbon at the beginning of application.css.scss:
-
- @import "bourbon";
-
-Import all additional stylesheets from your app/assets/stylesheets directory underneath the bourbon import:
+Import Bourbon at the beginning of application.css.scss. All additional stylesheets must be imported below Bourbon:
@import "bourbon";
@import "home";
@import "users";
-## Rails 3.0.x
-For Rails 3.0.x you must run the installation rake task. You should run this task every time a new version of Bourbon is released.
-This will copy the Sass files into your project's `public/stylesheets/sass` directory.
-
- rake bourbon:install
-Import the mixins at the beginning of your stylesheet
+[Help! I'm getting an undefined mixin error.](https://github.com/thoughtbot/bourbon/wiki/Rails-Help)
- @import 'bourbon/bourbon';
+##### [Rails 3.0.x Install Instructions](https://github.com/thoughtbot/bourbon/wiki/Rails-3.0.x-Install)
-*Optional*: If you use a non-standard location for your sass files, you can specify the path to your sass files as an argument to the install task
+##### Rails 2.3 - follow the [non-rails installation](#non-rails)
- rake bourbon:install[app/stylesheets]
+# <span id="non-rails"></span>Non-Rails projects
+Bourbon includes an easy way to generate a directory with all the necessary files.
+For command line help: `$ bourbon help` or visit the [Command line tools wiki](https://github.com/thoughtbot/bourbon/wiki/Command-Line-Tools)
-# Rails 2.3 or a non-Rails project (static site, jekyll, wordpress, etc...)
-Bourbon includes an easy way to generate a directory with all the necessary files.
-Install the bourbon gem:
+####Install
gem install bourbon
-Change the directory to where you want to generate the bourbon folder and files:
-
- cd project_name/stylesheets/sass/
-
-Install bourbon:
+Install Bourbon into the current directory by generating the `bourbon` folder:
bourbon install
-This will generate a folder called `bourbon` containing all the mixins and other necessary bourbon files. It is recommended not to add or modify the bourbon files so that you can update bourbon easily.
-
-Update an existing bourbon installation with:
-
- bourbon update
-
-This will delete the bourbon directory and regenerate it.
+<small>The generated folder will contain all the mixins and other necessary Bourbon files.
+It is recommended not to add or modify the Bourbon files so that you can update Bourbon easily.</small>
+#### Sass Watch
*Sass Watch:* To output properly, Bourbon must be explicitly required (`-r`) by Sass at the command line:
# Example (project root directory)
sass --watch stylesheets/sass:stylesheets -r ./stylesheets/sass/bourbon/lib/bourbon.rb
-You will need to import the mixins at the beginning of your stylesheet(s):
+Lastly, import the mixins at the beginning of your stylesheet(s):
@import 'bourbon/bourbon';
+#### Other Commands
+Visit the [Command line tools wiki](https://github.com/thoughtbot/bourbon/wiki/Command-Line-Tools) for a complete list
+
+ bourbon help
+ bourbon update
+
# Browser support
Bourbon aims to provide support for CSS3 properties that are not yet fully supported in modern stable browsers.
-# All Supported Functions, Mixins, and Addons
-[View the Bourbon documentation](http://bourbon.io)
-
## Help Out
Currently the project is a work in progress. Feel free to help out.
@@ -110,19 +95,24 @@ If the answer is yes, there is a high chance the mixin will be accepted via a pu
*Bourbon does not intend to support IE filters.*
-Resources for checking browser support: [MDN - Moz Dev Network](https://developer.mozilla.org/en-US/), [Mozilla CSS Extensions](https://developer.mozilla.org/en/CSS_Reference/Mozilla_Extensions), [Webkit CSS Properties](http://css-infos.net/properties/webkit.php), [Firefox CSS Properties](http://css-infos.net/properties/firefox.php), [MSDN - Microsoft Dev Network](http://msdn.microsoft.com/en-us/library/ms531207(v=VS.85).aspx)
+Resources for checking browser support:
+
+* [MDN - Moz Dev Network](https://developer.mozilla.org/en-US/)
+* [Mozilla CSS Extensions](https://developer.mozilla.org/en/CSS_Reference/Mozilla_Extensions)
+* [Webkit CSS Properties](http://css-infos.net/properties/webkit.php)
+* [MSDN - Microsoft Dev Network](http://msdn.microsoft.com/en-us/library/ms531207\(v=VS.85\).aspx)
Credits
-------
![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
-Got questions? Need help? Tweet at [@phillapier](http://twitter.com/phillapier).
-
Bourbon is maintained and funded by [thoughtbot, inc](http://thoughtbot.com/community)
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+Got questions? Need help? Tweet at [@phillapier](http://twitter.com/phillapier).
+
License
-------
Please sign in to comment.
Something went wrong with that request. Please try again.