1
0
Fork 0
mirror of https://github.com/twbs/bootstrap-sass.git synced 2022-11-09 12:27:02 -05:00
twbs--bootstrap-sass/README.md
AJ Acevedo f33e651ba7 Updated the documentation and corrected some typos
All upstream bootstrap links now point to the twbs/bootstrap repo.
2013-08-01 01:09:59 -04:00

1.8 KiB

Bootstrap for Sass

bootstrap-sass is an Sass-powered version of Bootstrap, ready to drop right into your Sass powered applications.

Usage

Rails

In your Gemfile:

gem 'sass-rails',   '~> 3.2.3'
gem 'bootstrap-sass', :git => 'git://github.com/thomas-mcdonald/bootstrap-sass.git', :branch => '3'

bundle install and restart your server to make the files available.

Upstream Converter

Keeping bootstrap-sass in sync with upstream changes from Bootstrap is an error prone and time consuming manual process. This branch is specifically concerned with automating that process as much as possible to allow a much faster release cycle.

Upstream changes to the Bootstrap project can now be pulled in using the convert rake task.

Here's an example run that would pull down the 3.0.0-wip branch from the main twbs/bootstrap repo:

% bundle exec rake 'convert[3.0.0-wip]'

The latest converter script is located here and does the following:

  • Converts upstream bootstrap LESS files to its matching SCSS file.
  • Copies all upstream JavaScript into vendor/assets/javascripts/bootstrap
  • Generates a javascript manifest at vendor/assets/javascripts/bootstrap.js
  • Copies all upstream font files into vendor/assets/fonts

This LESS to SCSS conversion is pretty good, but not perfect. So manual fixes to the resulting SCSS will be necessary for now. Please submit GitHub issues tagged with conversion to help track current shortcomings of the conversion process.

Who

bootstrap-sass is a project by Thomas McDonald, with support from other awesome people.