README.md in bootstrap-sass-3.3.0.1 vs README.md in bootstrap-sass-3.3.1.0

- old
+ new

@@ -15,11 +15,11 @@ `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. ```ruby -gem 'bootstrap-sass', '~> 3.3.0' +gem 'bootstrap-sass', '~> 3.3.1' gem 'sass-rails', '>= 3.2' ``` It is also recommended to use [Autoprefixer](https://github.com/ai/autoprefixer-rails) with Bootstrap to add browser vendor prefixes automatically. Simply add the gem: @@ -56,47 +56,46 @@ //= require bootstrap-sprockets ``` #### Bower with Rails -When using [bootstrap-sass Bower package](#c-bower) instead of the gem in Rails, add Bootstrap asset paths: +When using [bootstrap-sass Bower package](#c-bower) instead of the gem in Rails, configure assets in `config/application.rb`: ```ruby -# config/application.rb -# bootstrap-sass asset paths -root.join('vendor/assets/bower_components/bootstrap-sass/assets').tap do |path| - config.sass.load_paths << path.join('stylesheets') - config.assets.paths += %w(javascripts fonts images).map(&path.method(:join)) +# Bower asset paths +root.join('vendor', 'assets', 'bower_components').to_s.tap do |bower_path| + config.sass.load_paths << bower_path + config.assets.paths << bower_path end +# Precompile Bootstrap fonts +config.assets.precompile << %r(bootstrap-sass/assets/fonts/bootstrap/[\w-]+\.(?:eot|svg|ttf|woff)$) +# Minimum Sass number precision required by bootstrap-sass +::Sass::Script::Number.precision = [10, ::Sass::Script::Number.precision].max ``` -Then, ensure [minimum Sass number precision](#sass-number-precision): +Replace Bootstrap `@import` statements in `application.css.scss` with: -```ruby -# config/initializers/sass.rb -# Minimum precision required by bootstrap-sass -::Sass::Script::Number.precision = [10, ::Sass::Script::Number.precision].max +```scss +$icon-font-path: "bootstrap-sass/assets/fonts/bootstrap/"; +@import "bootstrap-sass/assets/stylesheets/bootstrap-sprockets"; +@import "bootstrap-sass/assets/stylesheets/bootstrap"; ``` +Replace Bootstrap `require` directive in `application.js` with: + +```js +//= require bootstrap-sass/assets/javascripts/bootstrap-sprockets +``` + #### Rails 4.x Please make sure `sprockets-rails` is at least v2.1.4. #### Rails 3.2.x -Rails 3.2 is [no longer maintained for bugfixes](http://guides.rubyonrails.org/maintenance_policy.html), and you should upgrade as soon as possible. +bootstrap-sass is no longer compatible with Rails 3. The latest version of bootstrap-sass compatible with Rails 3.2 is v3.1.1.0. -Starting with bootstrap-sass v3.1.1.1, due to the structural changes from upstream you will need these -backported asset pipeline gems on Rails 3.2. There is more on why this is necessary in -https://github.com/twbs/bootstrap-sass/issues/523 and https://github.com/twbs/bootstrap-sass/issues/578. - -```ruby -gem 'sprockets-rails', '=2.0.0.backport1' -gem 'sprockets', '=2.2.2.backport2' -gem 'sass-rails', github: 'guilleiguaran/sass-rails', branch: 'backport' -``` - ### b. Compass without Rails Install the gem ```sh gem install bootstrap-sass @@ -126,10 +125,10 @@ ``` This will create a new Compass project with the following files in it: * [styles.sass](/templates/project/styles.sass) - main project Sass file, imports Bootstrap and variables. -* [_bootstrap-variables.sass](/templates/project/_bootstrap-variables.sass.erb) - all of Bootstrap variables, override them here. +* [_bootstrap-variables.sass](/templates/project/_bootstrap-variables.sass) - all of Bootstrap variables, override them here. 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. Bower