Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 97 lines (64 sloc) 3.438 kb
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
1 # Compass Recipes ![project status](http://stillmaintained.com/MoOx/compass-recipes.png) #
61b688e @MoOx Update readme ( and todo)
MoOx authored
2
26a2ae1 @MoOx Update README to markdown
MoOx authored
3 This project is a collection of Sass mixins using Compass that you can use or learn from.
4
0ea714a @MoOx Update readme
MoOx authored
5 ## [Demos](http://moox.github.com/compass-recipes/)
4d55915 @MoOx move demos link in readme
MoOx authored
6
0ea714a @MoOx Update readme
MoOx authored
7 *This are demos of the repository at his current state. So it will be not reflection what is available into the last stable gem. To get what you see in the demos, see Installation to see how to install the repo at his current state*
8
9 ## What do we have here ?
10
11 * [backgrounds](http://moox.github.com/compass-recipes/recipes/background/) (patterns)
12 * [bases](http://moox.github.com/compass-recipes/recipes/base/) (just normalize.css from @necolas for now)
13 * [effects](http://moox.github.com/compass-recipes/recipes/effect/) (visual ones, not animations)
14 * [form skins](http://moox.github.com/compass-recipes/recipes/form/skin/) (just one, feel free to pull news)
15 * [icons](http://moox.github.com/compass-recipes/recipes/icon) recipes (just rules to use icons, not icons themselves)
16 * [layout](http://moox.github.com/compass-recipes/recipes/layout) recipes
17 * [media queries](http://moox.github.com/compass-recipes/recipes/media-queries) (predefined for commons devices width)
18 * [shadows](http://moox.github.com/compass-recipes/recipes/shadow/) (funky ones)
19 * [shapes](http://moox.github.com/compass-recipes/recipes/shape/) (geometrical ones, and some others fancy)
20 * [shared](http://moox.github.com/compass-recipes/recipes/shared/) (commons stuffs like hacks or tricks)
21 * [ui](http://moox.github.com/compass-recipes/recipes/ui/) (stuffs for UI - more incomming)
22
23 * *more incomming (see [compass recipes issues](/MoOx/compass-recipes/issues)), feel free to make a pull request to add your own !!*
4d55915 @MoOx move demos link in readme
MoOx authored
24
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
25 ## Installation
26
27 [Compass-Recipes is now available as a gem on RubyGems.org](https://rubygems.org/gems/compass-recipes). So installation is quite easy.
28
f228878 @MoOx Color highlights in README
MoOx authored
29 ```shell
30 gem install compass-recipes
31 ```
0ea714a @MoOx Update readme
MoOx authored
32
33 /!\ *If you want all latests recipes, you can just checkout the recipes (or download as zip) and add '{your-path-here-or-./}compass-recipes/stylesheets' using `additional_import_paths` or `add_import_path` (see [Compass configuration reference](http://compass-style.org/help/tutorials/configuration-reference/)*
34
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
35 # Usage
36
37 When compass-recipes installed, you just need to require the compass plugin in your project
38
6278f20 @MoOx Try color highlights
MoOx authored
39 ```css
40 require 'compass-recipes'
41 ```
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
42
43 Then you can include some recipes like this
44
6278f20 @MoOx Try color highlights
MoOx authored
45 ```css
46 @import "recipes/shape/triangle";
47 .my-triangle
48 {
49 @include triangle;
50 }
f228878 @MoOx Color highlights in README
MoOx authored
51 ```
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
52
53 Like Compass does, you can include all recipes in a folder like this
54
6278f20 @MoOx Try color highlights
MoOx authored
55 ```css
56 @import "recipes/shape";
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
57
6278f20 @MoOx Try color highlights
MoOx authored
58 .my-triangle
59 {
60 @include triangle;
61 }
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
62
6278f20 @MoOx Try color highlights
MoOx authored
63 .my-square
64 {
65 @include square;
66 }
67 ```
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
68
7785b60 @MoOx Update readme
MoOx authored
69 ## Author
70
71 Compass-Recipes is maintained by Maxime Thirouin, a front-end web developer working for Shopbot-inc.com
72
26a2ae1 @MoOx Update README to markdown
MoOx authored
73 ## Open to All
48238c5 @MoOx Update readme since compass-recipes is available as a gem
MoOx authored
74 Fork, modify, push, submit pull request ! That's easy !
75
c12aae8 @MoOx Just some Credits and thanks
MoOx authored
76 *I'm not a Ruby coder, so anyone which want to help me for anything will be appreciated !*
77
542c734 @MoOx Add how to build gh-pages (like sass-recipes does)
MoOx authored
78 ## Build Documentation
79
6d4a344 @MoOx Update read me + gitignore + gemfile
MoOx authored
80 First you need bundle
81
82 ```bundle install```
83
84 Then, to build the gh-pages from the `tests/`, you need to call
542c734 @MoOx Add how to build gh-pages (like sass-recipes does)
MoOx authored
85
86 ```bundle exec rake pages```
87
c12aae8 @MoOx Just some Credits and thanks
MoOx authored
88 ## Thanks (indirect contributors)
89
0ea714a @MoOx Update readme
MoOx authored
90 This project will never exists without these people : @necolas, @simurai, @chriscoyier, @leaverou.
91
c12aae8 @MoOx Just some Credits and thanks
MoOx authored
92 They give me inspiration (and snippets of code!).
5cfeab1 @MoOx Update Licence
MoOx authored
93
0ea714a @MoOx Update readme
MoOx authored
94 ## [MIT Licence](http://moox.mit-license.org/)
5cfeab1 @MoOx Update Licence
MoOx authored
95
0ea714a @MoOx Update readme
MoOx authored
96 ##### Notes
97 *Readme created using [Mou.app](http://mouapp.com/)*
Something went wrong with that request. Please try again.