Mercurial > p > roundup > code
comparison 3rdparty/bootstrap/README.md @ 4854:c109f7c1e477
Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
| author | Pradip Caulagi <caulagi@gmail.com> |
|---|---|
| date | Thu, 30 Jan 2014 14:50:57 +0530 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 4853:f211f5da0d74 | 4854:c109f7c1e477 |
|---|---|
| 1 # [Twitter Bootstrap v2.2.2](http://twitter.github.com/bootstrap) [](http://travis-ci.org/twitter/bootstrap) | |
| 2 | |
| 3 Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat). | |
| 4 | |
| 5 To get started, checkout http://getbootstrap.com! | |
| 6 | |
| 7 | |
| 8 | |
| 9 ## Quick start | |
| 10 | |
| 11 Three quick start options are available: | |
| 12 | |
| 13 * [Download the latest release](https://github.com/twitter/bootstrap/zipball/master). | |
| 14 * Clone the repo: `git clone git://github.com/twitter/bootstrap.git`. | |
| 15 * Install with Twitter's [Bower](http://twitter.github.com/bower): `bower install bootstrap`. | |
| 16 | |
| 17 | |
| 18 | |
| 19 ## Versioning | |
| 20 | |
| 21 For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible. | |
| 22 | |
| 23 Releases will be numbered with the following format: | |
| 24 | |
| 25 `<major>.<minor>.<patch>` | |
| 26 | |
| 27 And constructed with the following guidelines: | |
| 28 | |
| 29 * Breaking backward compatibility bumps the major (and resets the minor and patch) | |
| 30 * New additions without breaking backward compatibility bumps the minor (and resets the patch) | |
| 31 * Bug fixes and misc changes bumps the patch | |
| 32 | |
| 33 For more information on SemVer, please visit http://semver.org/. | |
| 34 | |
| 35 | |
| 36 | |
| 37 ## Bug tracker | |
| 38 | |
| 39 Have a bug or a feature request? [Please open a new issue](https://github.com/twitter/bootstrap/issues). Before opening any issue, please search for existing issues and read the [Issue Guidelines](https://github.com/necolas/issue-guidelines), written by [Nicolas Gallagher](https://github.com/necolas/). | |
| 40 | |
| 41 | |
| 42 | |
| 43 ## Community | |
| 44 | |
| 45 Keep track of development and community news. | |
| 46 | |
| 47 * Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap). | |
| 48 * Read and subscribe to the [The Official Twitter Bootstrap Blog](http://blog.getbootstrap.com). | |
| 49 * Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/twitter-bootstrap) | |
| 50 * Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel. | |
| 51 | |
| 52 | |
| 53 | |
| 54 ## Developers | |
| 55 | |
| 56 We have included a makefile with convenience methods for working with the Bootstrap library. | |
| 57 | |
| 58 + **dependencies** | |
| 59 Our makefile depends on you having recess, connect, uglify.js, and jshint installed. To install, just run the following command in npm: | |
| 60 | |
| 61 ``` | |
| 62 $ npm install recess connect uglify-js jshint -g | |
| 63 ``` | |
| 64 | |
| 65 + **build** - `make` | |
| 66 Runs the recess compiler to rebuild the `/less` files and compiles the docs pages. Requires recess and uglify-js. <a href="http://twitter.github.com/bootstrap/extend.html#compiling">Read more in our docs »</a> | |
| 67 | |
| 68 + **test** - `make test` | |
| 69 Runs jshint and qunit tests headlessly in [phantomjs](http://code.google.com/p/phantomjs/) (used for ci). Depends on having phantomjs installed. | |
| 70 | |
| 71 + **watch** - `make watch` | |
| 72 This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem. | |
| 73 | |
| 74 | |
| 75 | |
| 76 ## Contributing | |
| 77 | |
| 78 Please submit all pull requests against *-wip branches. If your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the [Code Guide](http://github.com/mdo/code-guide), maintained by [Mark Otto](http://github.com/mdo). | |
| 79 | |
| 80 Thanks! | |
| 81 | |
| 82 | |
| 83 | |
| 84 ## Authors | |
| 85 | |
| 86 **Mark Otto** | |
| 87 | |
| 88 + http://twitter.com/mdo | |
| 89 + http://github.com/mdo | |
| 90 | |
| 91 **Jacob Thornton** | |
| 92 | |
| 93 + http://twitter.com/fat | |
| 94 + http://github.com/fat | |
| 95 | |
| 96 | |
| 97 | |
| 98 ## Copyright and license | |
| 99 | |
| 100 Copyright 2012 Twitter, Inc. | |
| 101 | |
| 102 Licensed under the Apache License, Version 2.0 (the "License"); | |
| 103 you may not use this work except in compliance with the License. | |
| 104 You may obtain a copy of the License in the LICENSE file, or at: | |
| 105 | |
| 106 http://www.apache.org/licenses/LICENSE-2.0 | |
| 107 | |
| 108 Unless required by applicable law or agreed to in writing, software | |
| 109 distributed under the License is distributed on an "AS IS" BASIS, | |
| 110 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| 111 See the License for the specific language governing permissions and | |
| 112 limitations under the License. |