Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 77 lines (40 sloc) 3.214 kB
31d1aa6 @metaskills Basic project structures.
authored
1 # Less Rails Bootstrap
2
3 Bootstrap is Twitter's toolkit for kickstarting CSS for websites, apps, and more. It includes base CSS styles for typography, forms, buttons, tables, grids, navigation, alerts, and more. To get started -- checkout http://twitter.github.com/bootstrap!
4
c3f0c00 @metaskills Prepare for 1.3.0 release.
authored
5 The less-rails-bootstrap project hooks into less-rails (https://github.com/metaskills/less-rails) to provide both compiled and LESS CSS source files from the Twitter Bootstrap project within the Rails 3.1 asset pipeline. Benefits:
6
7 * Assets are namespaced in twitter/bootstrap to avoid asset conflicts.
8 * Top level requires to get all stylesheets or javascripts.
2a03ba2 @metaskills Another small doc change.
authored
9 * Ability to import or require individually namespaced stylesheets or javascripts.
31d1aa6 @metaskills Basic project structures.
authored
10
11
12 ## Versioning
13
14 This gem will directly track the semantic versioning releases of the Twitter Bootstrap project. Our major and minor versions will always match to theirs. Tho we may have tiny patch level releases specific to this gem.
15
16
17 ## Installing
18
e2e62bd @metaskills Update readme with new less-rails
authored
19 This library requires the less-rails gem greater than 2.0.0 to work. Our gem spec will pull this and less in automatically. So all you need to do is bundle up less-rails-bootstrap in your Gemfle.
c3f0c00 @metaskills Prepare for 1.3.0 release.
authored
20
21 ```ruby
e2e62bd @metaskills Update readme with new less-rails
authored
22 gem 'less-rails-bootstrap'
31d1aa6 @metaskills Basic project structures.
authored
23 ```
24
25
26 ## Usage
27
6483386 @metaskills Update README with working examples.
authored
28 Please see the [less-rails-bootstrap-test](http://github.com/metaskills/less-rails-bootstrap-test) project for working examples of how to use less.rb, less-rails, and less-rails-bootstrap in any way possible. The "CSS Tests Suites" section of the README and code is what you want to focus on.
c3f0c00 @metaskills Prepare for 1.3.0 release.
authored
29
30
6483386 @metaskills Update README with working examples.
authored
31 ### JavaScript Usage
c3f0c00 @metaskills Prepare for 1.3.0 release.
authored
32
6483386 @metaskills Update README with working examples.
authored
33 Using the JavaScript files is just as easy. You can include all them with a single directive from your `application.js` file. Optionally, you can require only the files you need like `require twitter/bootstrap/modal`.
c3f0c00 @metaskills Prepare for 1.3.0 release.
authored
34
35 ```javascript
36 //= require twitter/bootstrap
37
38 $(document).ready(function(){
39
40 });
41 ```
31d1aa6 @metaskills Basic project structures.
authored
42
43
bd8a92f @metaskills Update to use less-rails ~> 2.1.0
authored
44 ## Testing
45
3bff528 @1337807 Simple grammatical error.
1337807 authored
46 Simple! Just clone the repo, then run `bundle install` and `bundle exec rake`. The tests will begin to run. We also use Travis CI to run our tests. The current build status is:
bd8a92f @metaskills Update to use less-rails ~> 2.1.0
authored
47
48 [![Build Status](https://secure.travis-ci.org/metaskills/less-rails-bootstrap.png)](http://travis-ci.org/metaskills/less-rails-bootstrap)
49
2e7d759 @metaskills Note test integration project.
authored
50 We also have a test rails project setup using all the examples documented above. If you make a github issue and complain about something, I will likely forward you to this project.
51
52 [https://github.com/metaskills/less-rails-bootstrap-test](https://github.com/metaskills/less-rails-bootstrap-test)
bd8a92f @metaskills Update to use less-rails ~> 2.1.0
authored
53
54
31d1aa6 @metaskills Basic project structures.
authored
55 ## License
56
57 Twitter Bootstrap Project: http://twitter.github.com/bootstrap
58
59 Copyright 2011 Twitter, Inc.
60
61 Licensed under the Apache License, Version 2.0 (the "License");
62 you may not use this file except in compliance with the License.
63 You may obtain a copy of the License at
64
65 http://www.apache.org/licenses/LICENSE-2.0
66
67 Unless required by applicable law or agreed to in writing, software
68 distributed under the License is distributed on an "AS IS" BASIS,
69 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
70 See the License for the specific language governing permissions and
71 limitations under the License.
72
73 Less::Rails is Copyright (c) 2011 Ken Collins, <ken@metaskills.net> and is distributed under the MIT license.
74
75
76
Something went wrong with that request. Please try again.