2013-05-30 11:25:02 +04:00
|
|
|
# Bootstrap for Sass
|
2011-09-06 23:08:31 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
`bootstrap-sass` is an Sass-powered version of [Bootstrap][bootstrap], ready to drop right into your Sass powered applications.
|
2012-05-11 17:38:25 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
## Installation and Usage
|
2011-09-06 23:08:31 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
Please see the appropriate guide for your environment of choice:
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
* [Rails][railsguide]
|
|
|
|
|
* [Compass][compassguide]
|
|
|
|
|
* ---[Sass][sassguide]--- (*supported soon*)
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
## Development
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
### Upstream Converter
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
Keeping bootstrap-sass in sync with upstream changes from Bootstrap used to be an error prone and time consuming manual process.
|
|
|
|
|
With Bootstrap 3 we have introduced a converter that automates this.
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-01 09:09:59 +04:00
|
|
|
Upstream changes to the Bootstrap project can now be pulled in using the `convert` rake task.
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-21 20:30:32 +04:00
|
|
|
Here's an example run that would pull down the `3.0.0-wip` branch from the main twbs/bootstrap repo (defaults to `master`):
|
2013-05-30 11:25:02 +04:00
|
|
|
|
|
|
|
|
% bundle exec rake 'convert[3.0.0-wip]'
|
|
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
The latest converter script is located [here][converter] and does the following:
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-01 09:09:59 +04:00
|
|
|
* Converts upstream bootstrap LESS files to its matching SCSS file.
|
|
|
|
|
* Copies all upstream JavaScript into `vendor/assets/javascripts/bootstrap`
|
2013-05-30 11:25:02 +04:00
|
|
|
* Generates a javascript manifest at `vendor/assets/javascripts/bootstrap.js`
|
2013-08-21 20:30:32 +04:00
|
|
|
* Copies all upstream font files into `vendor/assets/fonts/bootstrap`
|
|
|
|
|
* Sets `Bootstrap::BOOTSTRAP_SHA` in [version.rb][version] to the branch sha.
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-01 09:09:59 +04:00
|
|
|
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.
|
2013-05-30 11:25:02 +04:00
|
|
|
|
2013-08-21 20:13:33 +04:00
|
|
|
## Credits
|
|
|
|
|
|
|
|
|
|
bootstrap-sass has a number of major contributors:
|
|
|
|
|
|
|
|
|
|
<!-- feel free to make these link wherever you wish -->
|
|
|
|
|
* [Thomas McDonald][tm]
|
|
|
|
|
* Tristan Harward
|
|
|
|
|
* Peter Gumeson
|
2013-08-21 20:30:32 +04:00
|
|
|
* [Gleb Mazovetskiy][glebm]
|
2013-08-21 20:13:33 +04:00
|
|
|
|
|
|
|
|
and a [significant number of other contributors][contrib].
|
|
|
|
|
|
|
|
|
|
[bootstrap]: https://github.com/twbs/bootstrap
|
2013-08-21 20:20:13 +04:00
|
|
|
[railsguide]: https://github.com/thomas-mcdonald/bootstrap-sass/blob/3/docs/RAILS.md
|
|
|
|
|
[compassguide]: https://github.com/thomas-mcdonald/bootstrap-sass/blob/3/docs/COMPASS.md
|
2013-08-21 20:13:33 +04:00
|
|
|
[sassguide]: #
|
|
|
|
|
[converter]: https://github.com/thomas-mcdonald/bootstrap-sass/blob/3/tasks/converter.rb
|
|
|
|
|
[tm]: https://twitter.com/thomasmcdonald_
|
2013-08-21 20:30:32 +04:00
|
|
|
[glebm]: https://github.com/glebm
|
|
|
|
|
[version]: https://github.com/thomas-mcdonald/bootstrap-sass/blob/3/lib/bootstrap-sass/version.rb
|
2013-08-21 20:13:33 +04:00
|
|
|
[contrib]: https://github.com/thomas-mcdonald/bootstrap-sass/graphs/contributors
|
