README.md in bootstrap-sass-3.0.2.1 vs README.md in bootstrap-sass-3.0.3.0
- old
+ new
@@ -14,11 +14,11 @@
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 'sass-rails', '>= 3.2' # sass-rails needs to be higher than 3.2
-gem 'bootstrap-sass', '~> 3.0.2.0'
+gem 'bootstrap-sass', '~> 3.0.3.0'
```
`bundle install` and restart your server to make the files available through the pipeline.
### b. Compass (no Rails)
@@ -34,25 +34,69 @@
# config.rb:
require 'bootstrap-sass'
```
```console
-compass install bootstrap
+bundle exec compass install bootstrap
```
If you are creating a new Compass project, you can generate it with bootstrap-sass support:
```console
-compass create my-new-project -r bootstrap-sass --using bootstrap
+bundle exec compass create my-new-project -r bootstrap-sass --using bootstrap
```
This will create a new Compass project with the following files in it:
* [_variables.scss](/templates/project/_variables.scss.erb) - all of bootstrap variables (override them here).
* [styles.scss](/templates/project/styles.scss) - main project SCSS file, import `variables` and `bootstrap`.
+### c. Sass-only (no Compass, nor Rails)
+
+Require the gem, and load paths and Sass helpers will be configured automatically:
+
+```ruby
+require 'bootstrap-sass'
+```
+
+When using outside ruby (e.g. as a bower package), disable ruby asset lookup helper:
+
+```sass
+$bootstrap-sass-asset-helper: false
+```
+
+
+#### 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:
+
+```sass
+"#{$icon-font-path}/#{$icon-font-name}.eot"
+```
+
+`$icon-font-path` defaults to `bootstrap/`.
+
+When not using an asset pipeline, you have to copy fonts and javascripts from the gem.
+
+```bash
+mkdir public/fonts
+cp -r $(bundle show bootstrap-sass)/vendor/assets/fonts/ public/fonts/
+mkdir public/javascripts
+cp -r $(bundle show bootstrap-sass)/vendor/assets/javascripts/ public/javascripts/
+```
+
+In ruby you can get the assets' location in the filesystem like this:
+
+```ruby
+Bootstrap.stylesheets_path
+Bootstrap.fonts_path
+Bootstrap.javascripts_path
+```
+
## Usage
### Sass
Import Bootstrap into a Sass file (for example, `application.css.scss`) to get all of Bootstrap's styles, mixins and variables!
@@ -108,9 +152,11 @@
```js
//= require bootstrap/scrollspy
//= require bootstrap/modal
//= require bootstrap/dropdown
```
+
+---
## Development and Contributing
If you'd like to help with the development of bootstrap-sass itself, read this section.