Permalink
Browse files

Fixup the README

  • Loading branch information...
1 parent 74b4450 commit 86e4078383ab591a179918a90059f54d06e5cbb9 Gabe Berke-Williams committed Sep 9, 2011
Showing with 38 additions and 38 deletions.
  1. +38 −38 readme.md
View
@@ -1,24 +1,24 @@
-#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 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.
-#Requirements
+# Requirements
Sass 3.1+
-
-#Install for Rails
+# Install for Rails
Update your Gemfile
gem 'bourbon'
- bundle install
+ $ bundle install
-##Rails 3.1.x
+## Rails 3.1.x
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.
+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
*= require_tree .
@@ -33,7 +33,7 @@ Import all additional stylesheets from your app/assets/stylesheets directory und
@import "home";
@import "users";
-##Rails 3.0.9 and below
+## Rails 3.0.9 and below
For Rails < 3.1 you must run the installation rake task. Please note, 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.
@@ -44,7 +44,7 @@ Import the mixins at the beginning of your stylesheet
@import 'bourbon/bourbon';
-#Install without Rails
+# Install without Rails
The following script will generate a *bourbon* directory and convert all .css.scss to .scss extensions. The *bourbon* directory is for 'sass --watch' use outside of rails.
Preliminary step: clone this repo and cd into the directory.
@@ -68,7 +68,7 @@ In this case as well, you will need to import the mixins at the beginning of you
@import 'bourbon/bourbon';
-#Browser support
+# 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.
@@ -81,11 +81,11 @@ Bourbon aims to provide support for CSS3 properties that are not yet fully suppo
Bourbon does not intend to support IE filters.
-#Using Bourbon Mixins
+# 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.
-###Animation
+### Animation
The animation mixins support comma separated lists of values, which allows different transitions for individual properties to be described in a single style rule. Each value in the list corresponds to the value at that same position in the other properties.
@@ -97,9 +97,9 @@ The animation mixins support comma separated lists of values, which allows diffe
@include animation-basic((slideup, fadein), (1.0s, 2.0s), ease-in);
-###Background-image
+### Background-image
-The background-image mixin is helpful for chaining multiple comma delimited background images and/or linear-gradients into one background-image property.Background-image supports up to 10 background-images.
+The background-image mixin is helpful for chaining multiple comma delimited background images and/or linear-gradients into one background-image property. background-image supports up to 10 background-images.
# Multiple image assets
@include background-image(url("/images/a.png"), url("images/b.png"));
@@ -111,32 +111,32 @@ The background-image mixin is helpful for chaining multiple comma delimited back
@include background-image(linear-gradient(hsla(0, 100%, 100%, 0.25) 0%, hsla(0, 100%, 100%, 0.08) 50%, transparent 50%), linear-gradient(#4e7ba3, darken(#4e7ba4, 10%)) );
-###Border Radius
+### Border Radius
-Border-radius will also take short-hand notation.
+border-radius will also take short-hand notation.
@include border-radius(10px);
@include border-radius(5px 5px 2px 2px);
-###Box Shadow
+### Box Shadow
-Box-Shadow supports single or multiple arguments:
+box-shadow supports single or multiple arguments:
@include box-shadow(1px 1px 2px 0 #ff0000);
# Multiple arguments must be comma-diliminated.
@include box-shadow(1px 1px 2px 0 #fff0000, -1px -2px 0 #ccc);
-###Box Sizing
+### Box Sizing
Box-sizing will change the box-model of the element it is applied to.
@include box-sizing(border-box);
-###Flex Box
+### Flex Box
The flex-box mixin is based on the 2009 w3c spec. The mixin with change to the flexible box-model. [More info.](http://www.w3.org/TR/2009/WD-css3-flexbox-20090723/)
@@ -157,14 +157,14 @@ The flex-box mixin is based on the 2009 w3c spec. The mixin with change to the f
}
-###Inline-block
+### Inline-block
The inline-block mixin provides support for the inline-block property in IE6 and IE7.
@include inline-block;
-###Linear-Gradient
+### Linear-Gradient
Gradient position is optional, default is top. Position can be a degree. Color-stops are optional as well. Mixin will support up to 10 gradients.
@@ -173,7 +173,7 @@ Gradient position is optional, default is top. Position can be a degree. Color-s
@include linear-gradient(50deg, #1e5799 0%, #2989d8 50%, #207cca 51%, #7db9e8 100%);
-###Position
+### Position
Shorthand notation for setting the position of elements in your page.
@@ -192,21 +192,21 @@ The first parameter is optional, with a default value of relative. The second pa
Note: unit-less values will be ignored. In the example above, this means that selectors will not be generated for the right and bottom positions, while the top position is set to 0px.
-###Radial-Gradient
+### Radial-Gradient
Takes up to 10 gradients. Position and shape are required.
@include radial-gradient(50% 50%, circle cover, #1e5799, #efefef);
@include radial-gradient(50% 50%, circle cover, #eee 10%, #1e5799 30%, #efefef);
-###Transform & Transform-origin
+### Transform & Transform-origin
@include transform(translateY(50px));
@include transform-origin(center top);
-###Transitions
+### Transitions
Shorthand mixin: Supports multiple parentheses-delimited values for each variable.
@@ -215,15 +215,15 @@ Shorthand mixin: Supports multiple parentheses-delimited values for each variabl
@include transition ($property:(opacity, width), $delay: (1.5s, 2.5s));`
-##Functions
-###Compact
+## Functions
+### Compact
The compact function will strip out any value from a list that is 'false'. Takes up to 10 arguments.
$full: compact($name-1, $name-2, $name-3, $name-4, $name-5, $name-6, $name-7, $name-8, $name-9, $name-10);
-###Golden Ratio
+### Golden Ratio
Returns the golden ratio of a given number. Must provide a Pixel or Em value for first argument. Also takes a required increment value that is not zero and an integer: ...-3, -2, -1, 1, 2, 3...
@@ -242,7 +242,7 @@ Returns the golden ratio of a given number. Must provide a Pixel or Em value for
Resources: [modularscale.com](http://modularscale.com) & [goldenratiocalculator.com](http://goldenratiocalculator.com)
-###Linear-gradient
+### Linear-gradient
Outputs a linear-gradient. Use in conjunction with the background-image mixin. The function takes the same arguments as the linear-gradient mixin (See Mixins section of this README).
@@ -253,7 +253,7 @@ Outputs a linear-gradient. Use in conjunction with the background-image mixin. T
@include background-image(linear-gradient(hsla(0, 100%, 100%, 0.25) 0%, hsla(0, 100%, 100%, 0.08) 50%, transparent 50%), linear-gradient(#4e7ba3, darken(#4e7ba4, 10%)) );
-###Grid-width
+### Grid-width
Easily setup and follow a grid based design. Need help busting a move grid-style?!? Check out [gridulator.com](http://gridulator.com/)
@@ -267,7 +267,7 @@ Easily setup and follow a grid based design. Need help busting a move grid-style
}
-###Tint & Shade
+### Tint & Shade
Tint & shade are different from lighten() and darken() functions built into sass.
Tint is a mix of a color with white. Tint takes a color and a percent argument.
@@ -283,9 +283,9 @@ Shade is a mix of a color with black. Shade takes a color and a percent argument
}
-##Add-ons
+## Add-ons
-###Buttons
+### Buttons
The button add-on provides well-designed buttons with a single line in your CSS.
The mixin supports a style parameter and an optional color argument. The available styles are **"simple"** (default), **"shiny"**, and **"pill"**.
@@ -308,7 +308,7 @@ Create beautiful buttons by defining a style and color argument; using a single
}
-###Timing functions
+### Timing functions
These CSS cubic-bezier timing functions are variables that can be used with CSS3 animations. The provided timing functions are the same as the jQuery UI demo: [easing functions](http://jqueryui.com/demos/effect/easing.html).
Variables supported: $ease-in-*, $ease-out-*, $ease-in-out-*
@@ -318,7 +318,7 @@ These CSS cubic-bezier timing functions are variables that can be used with CSS3
@include animation-basic(fade-in, 1s, $ease-in-quad);
-#All Supported Functions, Mixins, and Addons
+# All Supported Functions, Mixins, and Addons
*@ denotes a mixin and must be prefaced with @include*
#Functions
@@ -381,7 +381,7 @@ These CSS cubic-bezier timing functions are variables that can be used with CSS3
timing-functions ($ease-in-*, $ease-out-*, $ease-in-out-*)
-##Help Out
+## 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

0 comments on commit 86e4078

Please sign in to comment.