Mercurial > p > roundup > code

annotate 3rdparty/bootstrap/README.md @ 5695:3e1b66c4e1e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update docs. Correct errors reported by setup.py build_docs. Add rest interface and link to rest doc to features page. Add link to xmlrpc doc to features page. Add rest doc to index. Update rest doc, hopefully clarify confusing use of parameters in patch action section. Fix code examples in "Adding new rest endpoints" section. Fix example adding import of exception.
author John Rouillard <rouilj@ieee.org>
date Sun, 07 Apr 2019 20:17:52 -0400
parents c109f7c1e477
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4854
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
1 # [Twitter Bootstrap v2.2.2](http://twitter.github.com/bootstrap) [![Build Status](https://secure.travis-ci.org/twitter/bootstrap.png)](http://travis-ci.org/twitter/bootstrap)
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
2
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
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).
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
4
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
5 To get started, checkout http://getbootstrap.com!
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
6
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
7
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
8
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
9 ## Quick start
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
10
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
11 Three quick start options are available:
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
12
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
13 * [Download the latest release](https://github.com/twitter/bootstrap/zipball/master).
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
14 * Clone the repo: `git clone git://github.com/twitter/bootstrap.git`.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
15 * Install with Twitter's [Bower](http://twitter.github.com/bower): `bower install bootstrap`.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
16
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
17
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
18
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
19 ## Versioning
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
20
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
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.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
22
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
23 Releases will be numbered with the following format:
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
24
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
25 `<major>.<minor>.<patch>`
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
26
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
27 And constructed with the following guidelines:
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
28
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
29 * Breaking backward compatibility bumps the major (and resets the minor and patch)
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
30 * New additions without breaking backward compatibility bumps the minor (and resets the patch)
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
31 * Bug fixes and misc changes bumps the patch
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
32
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
33 For more information on SemVer, please visit http://semver.org/.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
34
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
35
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
36
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
37 ## Bug tracker
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
38
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
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/).
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
40
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
41
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
42
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
43 ## Community
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
44
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
45 Keep track of development and community news.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
46
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
47 * Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap).
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
48 * Read and subscribe to the [The Official Twitter Bootstrap Blog](http://blog.getbootstrap.com).
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
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)
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
50 * Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
51
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
52
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
53
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
54 ## Developers
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
55
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
56 We have included a makefile with convenience methods for working with the Bootstrap library.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
57
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
58 + **dependencies**
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
59 Our makefile depends on you having recess, connect, uglify.js, and jshint installed. To install, just run the following command in npm:
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
60
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
61 ```
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
62 $ npm install recess connect uglify-js jshint -g
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
63 ```
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
64
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
65 + **build** - `make`
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
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 &raquo;</a>
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
67
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
68 + **test** - `make test`
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
69 Runs jshint and qunit tests headlessly in [phantomjs](http://code.google.com/p/phantomjs/) (used for ci). Depends on having phantomjs installed.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
70
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
71 + **watch** - `make watch`
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
72 This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the Watchr gem.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
73
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
74
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
75
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
76 ## Contributing
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
77
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
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).
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
79
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
80 Thanks!
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
81
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
82
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
83
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
84 ## Authors
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
85
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
86 **Mark Otto**
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
87
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
88 + http://twitter.com/mdo
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
89 + http://github.com/mdo
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
90
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
91 **Jacob Thornton**
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
92
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
93 + http://twitter.com/fat
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
94 + http://github.com/fat
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
95
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
96
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
97
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
98 ## Copyright and license
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
99
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
100 Copyright 2012 Twitter, Inc.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
101
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
102 Licensed under the Apache License, Version 2.0 (the "License");
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
103 you may not use this work except in compliance with the License.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
104 You may obtain a copy of the License in the LICENSE file, or at:
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
105
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
106 http://www.apache.org/licenses/LICENSE-2.0
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
107
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
108 Unless required by applicable law or agreed to in writing, software
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
109 distributed under the License is distributed on an "AS IS" BASIS,
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
110 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
111 See the License for the specific language governing permissions and
c109f7c1e477 Add local copy of Bootstrap v2.2.2 (for packaging on Debian)
Pradip Caulagi <caulagi@gmail.com>
parents:
diff changeset
112 limitations under the License.
Roundup Issue Tracker: http://roundup-tracker.org/