Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 140 lines (75 sloc) 3.521 kB
670ecbe @vwall update readme
vwall authored
1 # Twitter Bootstrap - For Compass
f3388f7 @vwall add readme
vwall authored
2
3 Compass Twitter Bootstrap is Twitter's toolkit converted for Compass.
4
d2515e1 @vwall Update README.md
vwall authored
5 Demo App at https://github.com/vwall/Compass-Twitter-Bootstrap-Demo-App
670ecbe @vwall update readme
vwall authored
6
f3388f7 @vwall add readme
vwall authored
7 ## Usage
8
9 **Install the gem**
10
95506c5 @vwall Edited README
vwall authored
11 gem install compass_twitter_bootstrap
f3388f7 @vwall add readme
vwall authored
12
95506c5 @vwall Edited README
vwall authored
13 **Add it to your Gemfile**
f3388f7 @vwall add readme
vwall authored
14
95506c5 @vwall Edited README
vwall authored
15 gem 'compass_twitter_bootstrap'
f3388f7 @vwall add readme
vwall authored
16
95506c5 @vwall Edited README
vwall authored
17 **Bundle install**
18
19 bundle install
f3388f7 @vwall add readme
vwall authored
20
21 **Add it to your Compass config.rb**
22
95506c5 @vwall Edited README
vwall authored
23 require 'compass_twitter_bootstrap'
f3388f7 @vwall add readme
vwall authored
24
297690e @joliss typo
joliss authored
25 **Import it into your SCSS file**
f3388f7 @vwall add readme
vwall authored
26
95506c5 @vwall Edited README
vwall authored
27 @import "compass_twitter_bootstrap";
f3388f7 @vwall add readme
vwall authored
28
670ecbe @vwall update readme
vwall authored
29 ## Usage with asset pipeline(Rails 3.2)
3f0b0ea @ascrazy Add usage wirh Asset Pipeline(Rails 3.1)
ascrazy authored
30
ef256a7 @ucbklu Clarify that both gems need to be added to Gemfile.
ucbklu authored
31 **Add these gems to your Gemfile. To learn about the new compass-rails gem, see https://github.com/Compass/compass-rails for more info.**
3f0b0ea @ascrazy Add usage wirh Asset Pipeline(Rails 3.1)
ascrazy authored
32
33 gem 'compass_twitter_bootstrap'
670ecbe @vwall update readme
vwall authored
34 gem 'compass-rails'
35
3f0b0ea @ascrazy Add usage wirh Asset Pipeline(Rails 3.1)
ascrazy authored
36 **Bundle install**
37
38 bundle install
39
40 **Add it to your Application.rb**
41
42 # Enable the asset pipeline
43 config.assets.enabled = true
44
544fcef @ascrazy Edit usage wirh Asset Pipeline(Rails 3.1)
ascrazy authored
45 **Import it into your SCSS file**
3f0b0ea @ascrazy Add usage wirh Asset Pipeline(Rails 3.1)
ascrazy authored
46
47 @import "compass_twitter_bootstrap"
d2f0efb @tjgfernandes rails 3.1.1 plugin install support
tjgfernandes authored
48
670ecbe @vwall update readme
vwall authored
49 **Import twitter bootstrap responsive if you're looking for that**
50
51 @import "compass_twitter_bootstrap_responsive"
52
d2f0efb @tjgfernandes rails 3.1.1 plugin install support
tjgfernandes authored
53
670ecbe @vwall update readme
vwall authored
54 ## Usage with Rails 3.1 (via plugin)
d2f0efb @tjgfernandes rails 3.1.1 plugin install support
tjgfernandes authored
55
56 **Install plugin**
57
4be69d8 @vwall Clean up README.bd
vwall authored
58 rails plugin install git://github.com/vwall/compass-twitter-bootstrap.git
d2f0efb @tjgfernandes rails 3.1.1 plugin install support
tjgfernandes authored
59
60 **Add it to your config/initializers/sass.rb**
61
4be69d8 @vwall Clean up README.bd
vwall authored
62 Rails.configuration.sass.tap do |config|
63 ...
64
65 # twitter bootstrap
66 config.load_paths << Compass::Frameworks['twitter_bootstrap'].stylesheets_directory
67
68 ...
f062e0c @vwall Update README.md
vwall authored
69 end
d2f0efb @tjgfernandes rails 3.1.1 plugin install support
tjgfernandes authored
70
71 **Import it into your SCSS file**
72
73 @import "compass_twitter_bootstrap"
74
f3388f7 @vwall add readme
vwall authored
75
100ad6e Adding font-awesome option to the project
Chris Nicola authored
76 ## Using [Font Awesome](http://fortawesome.github.com/Font-Awesome/)
77
78 To use the font awesome font and icons simply change the standard import to:
79
80 @import "compass_twitter_bootstrap_awesome"
81
a5272d7 @matenia Added bootstrap-all for asset pipeline and updated docs
matenia authored
82 ## Using Javascripts with Rails Asset Pipeline
83
84 Javascript Libraries are located in vendor/assets/javascripts
85
86 Include them individually or
87
88 //=require bootstrap-all
89
90 to include all files
91
1962659 @kristianmandrup added conversion tip in readme
authored
92 ## SCSS to SASS Conversion tip
93
94 To easily convert `.scss` files to `.sass` files you can use this little bash script:
95
96 `$ for f in *.scss; do sass-convert -F scss -T sass $f ${f%%.*}.sass; done`
97
98 To convert all twitter bootstrap .scss files to .sass (with overwrite):
99
100 `$ for f in stylesheets/compass_twitter_bootstrap/*.scss; do sass-convert -F scss -T sass $f stylesheets_sass/compass_twitter_bootstrap/${f%%.*}.sass; done`
101
102 `$ for f in stylesheets/*.scss; do sass-convert -F scss -T sass $f stylesheets_sass/${f%%.*}.sass; done`
103
104 Nice and easy :)
a5272d7 @matenia Added bootstrap-all for asset pipeline and updated docs
matenia authored
105
f3388f7 @vwall add readme
vwall authored
106 ## TWITTER BOOTSTRAP
107
108 Bootstrap is Twitter's toolkit for kickstarting CSS for websites, apps, and more. It includes base CSS styles for typography, forms, buttons, tables, grids, navigation, alerts, and more.
109
110 To get started -- checkout http://twitter.github.com/bootstrap!
111
112 ## AUTHORS
113
114 **Mark Otto**
115
116 + http://twitter.com/mdo
117 + http://github.com/markdotto
118
119 **Jacob Thornton**
120
121 + http://twitter.com/fat
122 + http://github.com/fat
123
124
125 ##Copyright and License
126
127 Copyright 2011 Twitter, Inc.
128
129 Licensed under the Apache License, Version 2.0 (the "License");
130 you may not use this work except in compliance with the License.
131 You may obtain a copy of the License in the LICENSE file, or at:
132
133 http://www.apache.org/licenses/LICENSE-2.0
134
135 Unless required by applicable law or agreed to in writing, software
136 distributed under the License is distributed on an "AS IS" BASIS,
137 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
138 See the License for the specific language governing permissions and
4be69d8 @vwall Clean up README.bd
vwall authored
139 limitations under the License.
Something went wrong with that request. Please try again.