Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Comparing changes

Choose two branches to see what's changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
base fork: thoughtbot/bourbon
...
head fork: axsuul/bourbon
Checking mergeability… Don't worry, you can still create the pull request.
  • 1 commit
  • 1 file changed
  • 0 commit comments
  • 1 contributor
Commits on Nov 17, 2011
@gabebw gabebw Fix up README. b9b9628
Showing with 26 additions and 25 deletions.
  1. +26 −25 readme.md
View
51 readme.md
@@ -1,7 +1,10 @@
# Bourbon Sass Mixins
-The purpose of Bourbon Sass Mixins is to provide a comprehensive library of sass mixins that are designed to be as vanilla as possible, meaning they should not deter from the original CSS syntax.
-The mixins contain vendor specific prefixes for all CSS3 properties for support amongst modern browsers. The prefixes also ensure graceful degradation for older browsers that support only CSS3 prefixed properties.
-Bourbon uses SCSS syntax.
+The purpose of Bourbon Sass Mixins is to provide a comprehensive library of Sass
+mixins that are designed to be as vanilla as possible, meaning they should not
+deter you from using the original CSS syntax.
+The mixins contain vendor specific prefixes for all CSS3 properties for support
+amongst modern browsers. The prefixes also ensure graceful degradation for older
+browsers that support only CSS3 prefixed properties. Bourbon uses SCSS syntax.
# Requirements
Sass 3.1+
@@ -11,25 +14,26 @@ In your Gemfile:
gem 'bourbon'
-And run:
+Then run:
$ bundle install
## Rails 3.1.x
-Rename application.css to application.css.scss
+
+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 disabled the require_tree sprocket directive.
-Delete the following sprocket directive in 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:
*= require_tree .
-Import bourbon at the beginning of application.css.scss
+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 all additional stylesheets from your app/assets/stylesheets directory underneath the bourbon import:
@import "bourbon";
@import "home";
@@ -45,14 +49,13 @@ Import the mixins at the beginning of your stylesheet
@import 'bourbon/bourbon';
-*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
+*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
rake bourbon:install[app/stylesheets]
# Install without Rails
Bourbon includes an easy way to generate a directory with all the necessary files.
-
rake generate
This will create a `bourbon` directory that can be used by `sass --watch`. Move
@@ -70,19 +73,6 @@ In this case, you will need to import the mixins at the beginning of your styles
# Browser support
Bourbon aims to provide support for CSS3 properties that are not yet fully supported in modern stable browsers.
-**Pull requests:** A general rule when considering a new mixin: Do the following browsers *only* support the CSS3 property using vendor specific prefixes? If the answer is yes, there is a high chance the mixin will be accepted via a pull request.
-
-* Firefox 3.6+
-* Safari 4.0+
-* Chrome 4.0+
-* Opera 10+
-* IE 9+
-
-*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)
-
-
# Using Bourbon Mixins
Below are a few examples of mixin usage. Note that these are just a few, explore the repo to find out more.
@@ -459,7 +449,18 @@ These CSS cubic-bezier timing functions are variables that can be used with CSS3
## Help Out
Currently the project is a work in progress. Feel free to help out.
-**Pull requests:** See *Browser Support* in this readme for more info
+A general rule when considering filing a pull request for a new mixin: Do the following browsers *only* support the CSS3 property using vendor specific prefixes?
+If the answer is yes, there is a high chance the mixin will be accepted via a pull request.
+
+* Firefox 3.6+
+* Safari 4.0+
+* Chrome 4.0+
+* Opera 10+
+* IE 9+
+
+*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)
Credits
-------

No commit comments for this range

Something went wrong with that request. Please try again.