readme-template.md.erb in bootstrap-generators-3.1.1.2 vs readme-template.md.erb in bootstrap-generators-3.1.1.3
- old
+ new
@@ -4,11 +4,11 @@
Bootstrap-generators provides [Twitter Bootstrap](http://getbootstrap.com/) generators for Rails 4 (supported Rails >= 3.1). Bootstrap is a toolkit from Twitter designed to kickstart development of webapps and sites.
## Current Twitter Bootstrap version
-The current version of Twitter Bootstrap is <%= bootstrap_version %>.
+The current supported version of Twitter Bootstrap is <%= bootstrap_version %>.
## Installing Gem
In your Gemfile, add this line:
@@ -38,23 +38,25 @@
## Usage
To print the options and usage run the command `rails generate bootstrap:install --help`
- rails generate bootstrap:install [options]
+ Usage:
+ rails generate bootstrap:install [options]
Options:
- -e, [--template-engine=TEMPLATE_ENGINE] # Indicates when to generate template engine
- # Default: erb
- -se, [--stylesheet-engine=STYLESHEET_ENGINE] # Indicates when to generate stylesheet engine
- # Default: scss
+ -e, [--template-engine=TEMPLATE_ENGINE] # Indicates when to generate template engine
+ # Default: erb
+ -se, [--stylesheet-engine=STYLESHEET_ENGINE] # Indicates when to generate stylesheet engine
+ # Default: scss
+ [--skip-turbolinks], [--no-skip-turbolinks] # Indicates when to generate skip turbolinks
Runtime options:
- -f, [--force] # Overwrite files that already exist
- -p, [--pretend] # Run but do not make any changes
- -q, [--quiet] # Supress status output
- -s, [--skip] # Skip files that already exist
+ -f, [--force] # Overwrite files that already exist
+ -p, [--pretend], [--no-pretend] # Run but do not make any changes
+ -q, [--quiet], [--no-quiet] # Suppress status output
+ -s, [--skip], [--no-skip] # Skip files that already exist
Copy BootstrapGenerators default files
### Options
@@ -93,21 +95,23 @@
* CSS
* SCSS
* LESS
+##### SCSS
+
Make sure you have `sass-rails` dependency on your Gemfile:
gem 'sass-rails'
And then run:
rails generate bootstrap:install --stylesheet-engine=scss
Now you can customize the look and feel of Bootstrap.
-* LESS
+##### LESS
Add the dependency on your Gemfile:
gem 'therubyracer', platforms: :ruby
gem 'less-rails'
@@ -115,9 +119,13 @@
And then run:
rails generate bootstrap:install --stylesheet-engine=less
Now you can customize the look and feel of Bootstrap.
+
+#### Skip turbolinks
+
+Run the generator with option `--skip-turbolinks` to remove turbolinks references from the generated layout.
## Assets
### Customize and extend Bootstrap