README.md in bootstrap-sass-3.1.0.1 vs README.md in bootstrap-sass-3.1.0.2
- old
+ new
@@ -6,11 +6,11 @@
## Installation
Please see the appropriate guide for your environment of choice:
-### a. Rails
+### a. Ruby on Rails
`bootstrap-sass` is easy to drop into Rails with the asset pipeline.
In your Gemfile you need to add the `bootstrap-sass` gem, and ensure that the `sass-rails` gem is present - it is added to new Rails applications by default.
@@ -19,12 +19,18 @@
gem 'bootstrap-sass', '~> 3.1.0'
```
`bundle install` and restart your server to make the files available through the pipeline.
-### b. Compass (no Rails)
+#### Rails 3.2.x
+
+For Rails 3.2.x, make sure that all the gems are moved out of the `:assets` group, and `config.assets.initialize_on_precompile` is set to `true`.
+
+
+### b. Compass without Rails
+
Install the gem
```sh
gem install bootstrap-sass
```
@@ -51,26 +57,30 @@
* [styles.scss](/templates/project/styles.scss) - main project SCSS file, import `variables` and `bootstrap`.
Some bootstrap-sass mixins may conflict with the Compass ones.
If this happens, change the import order so that Compass mixins are loaded later.
-### c. Sass-only (no Compass, nor Rails)
+### c. Ruby without Compass / Rails
Require the gem, and load paths and Sass helpers will be configured automatically:
```ruby
require 'bootstrap-sass'
```
-Using bootstrap-sass as a Bower package is still being tested. You can install it with:
+### d. Bower
+Using bootstrap-sass as a Bower package is still being tested and requires libsass master. You can install it with:
+
```bash
-bower install 'git://github.com/twbs/bootstrap-sass.git#v3.1.0'
+bower install git://github.com/twbs/bootstrap-sass.git
```
-The files are located at [vendor/assets](/vendor/assets).
+`bootstrap-sass` is taken so make sure you use the Git URL above.
+Sass, JS, and all other assets are located at [vendor/assets](/vendor/assets).
+
#### JS and fonts
If you are using Rails or Sprockets, see Usage.
If none of Rails/Sprockets/Compass were detected the fonts will be referenced as:
@@ -128,11 +138,11 @@
You can also import components explicitly. To start with a full list of modules copy this file from the gem:
```bash
# copy and prepend "bootstrap/" to the @import paths:
sed 's/@import "/@import "bootstrap\//' \
- $(bundle show bootstrap-sass)/vendor/assets/stylesheets/bootstrap/bootstrap.scss > \
+ $(bundle show bootstrap-sass)/vendor/assets/stylesheets/bootstrap.scss > \
app/assets/stylesheets/bootstrap-custom.scss
```
Comment out components you do not want from `bootstrap-custom`.
In `application.sass`, replace `@import 'bootstrap'` with:
@@ -209,10 +219,10 @@
bootstrap-sass is used to build some awesome projects all over the web, including
[Diaspora](http://diasporaproject.org/), [rails_admin](https://github.com/sferik/rails_admin),
Michael Hartl's [Rails Tutorial](http://railstutorial.org/), [gitlabhq](http://gitlabhq.com/) and
[kandan](http://kandanapp.com/).
-[converter]: https://github.com/twbs/bootstrap-sass/blob/3/tasks/converter.rb
-[version]: https://github.com/twbs/bootstrap-sass/blob/3/lib/bootstrap-sass/version.rb
+[converter]: https://github.com/twbs/bootstrap-sass/blob/master/tasks/converter/less_conversion.rb
+[version]: https://github.com/twbs/bootstrap-sass/blob/master/lib/bootstrap-sass/version.rb
[contrib]: https://github.com/twbs/bootstrap-sass/graphs/contributors
[antirequire]: https://github.com/twbs/bootstrap-sass/issues/79#issuecomment-4428595
[jsdocs]: http://getbootstrap.com/javascript/#transitions