diff options
Diffstat (limited to 'bower_components/bootstrap/README.md')
| -rw-r--r-- | bower_components/bootstrap/README.md | 65 |
1 files changed, 36 insertions, 29 deletions
diff --git a/bower_components/bootstrap/README.md b/bower_components/bootstrap/README.md index 67cbb4ab..da5dfe22 100644 --- a/bower_components/bootstrap/README.md +++ b/bower_components/bootstrap/README.md @@ -1,19 +1,29 @@ -# [Bootstrap](http://getbootstrap.com) [](http://travis-ci.org/twbs/bootstrap) [](https://david-dm.org/twbs/bootstrap#info=devDependencies) +# [Bootstrap](http://getbootstrap.com) [](http://travis-ci.org/twbs/bootstrap) [](https://david-dm.org/twbs/bootstrap#info=devDependencies) [](https://saucelabs.com/u/bootstrap) -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). +Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat), and maintained by the [core team](https://github.com/twbs?tab=members) with the massive support and involvement of the community. To get started, check out <http://getbootstrap.com>! +## Table of contents + - [Quick start](#quick-start) + - [Bugs and feature requests](#bugs-and-feature-requests) + - [Documentation](#documentation) + - [Compiling CSS and JavaScript](#compiling-css-and-javascript) + - [Contributing](#contributing) + - [Community](#community) + - [Versioning](#versioning) + - [Authors](#authors) + - [Copyright and license](#copyright-and-license) ## Quick start Three quick start options are available: -* [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.0.3.zip). -* Clone the repo: `git clone https://github.com/twbs/bootstrap.git`. -* Install with [Bower](http://bower.io): `bower install bootstrap`. +- [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.1.0.zip). +- Clone the repo: `git clone https://github.com/twbs/bootstrap.git`. +- Install with [Bower](http://bower.io): `bower install bootstrap`. Read the [Getting Started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more. @@ -44,10 +54,7 @@ We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified ## Bugs and feature requests -Have a bug or a feature request? [Please open a new issue](https://github.com/twbs/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/). - -You may use [this JS Bin](http://jsbin.com/aKiCIDO/1/edit) as a template for your bug reports. - +Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/twbs/bootstrap/issues/new). ## Documentation @@ -57,8 +64,9 @@ Bootstrap's documentation, included in this repo in the root directory, is built ### Running documentation locally 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.x). + - **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems. We use Pygments for syntax highlighting, so make sure to read the sections on installing Python and Pygments. 2. From the root `/bootstrap` directory, run `jekyll serve` in the command line. - - **Windows users:** run `chcp 65001` first to change the command prompt's character encoding ([code page](http://en.wikipedia.org/wiki/Windows_code_page)) to UTF-8 so Jekyll runs without errors. + - **Windows users:** While we use Jekyll's `encoding` setting, you might still need to change the command prompt's character encoding ([code page](http://en.wikipedia.org/wiki/Windows_code_page)) to UTF-8 so Jekyll runs without errors. For Ruby 2.0.0, run `chcp 65001` first. For Ruby 1.9.3, you can alternatively do `SET LANG=en_EN.UTF-8`. 3. Open <http://localhost:9001> in your browser, and voilà. Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). @@ -80,7 +88,7 @@ Bootstrap uses [Grunt](http://gruntjs.com/) with convenient methods for working From the command line: 1. Install `grunt-cli` globally with `npm install -g grunt-cli`. -2. Navigate to the root `/bootstrap` directory, then run `npm install`. npm will look at [package.json](package.json) and automatically install the necessary local dependencies listed there. +2. Navigate to the root `/bootstrap` directory, then run `npm install`. npm will look at [package.json](https://github.com/twbs/bootstrap/blob/master/package.json) and automatically install the necessary local dependencies listed there. When completed, you'll be able to run the various Grunt commands provided from the command line. @@ -89,10 +97,10 @@ When completed, you'll be able to run the various Grunt commands provided from t ### Available Grunt commands #### Build - `grunt` -Run `grunt` to run tests locally and compile the CSS and JavaScript into `/dist`. **Uses [recess](http://twitter.github.io/recess/) and [UglifyJS](http://lisperator.net/uglifyjs/).** +Run `grunt` to run tests locally and compile the CSS and JavaScript into `/dist`. **Uses [Less](http://lesscss.org/) and [UglifyJS](http://lisperator.net/uglifyjs/).** #### Only compile CSS and JavaScript - `grunt dist` -`grunt dist` creates the `/dist` directory with compiled files. **Uses [recess](http://twitter.github.io/recess/) and [UglifyJS](http://lisperator.net/uglifyjs/).** +`grunt dist` creates the `/dist` directory with compiled files. **Uses [Less](http://lesscss.org/) and [UglifyJS](http://lisperator.net/uglifyjs/).** #### Tests - `grunt test` Runs [JSHint](http://jshint.com) and [QUnit](http://qunitjs.com/) tests headlessly in [PhantomJS](http://phantomjs.org/) (used for CI). @@ -110,28 +118,27 @@ Should you encounter problems with installing dependencies or running Grunt comm Please read through our [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. -More over, 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). +Moreover, 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). -Editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>. +Editor preferences are available in the [editor config](https://github.com/twbs/bootstrap/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>. -With v3.1, we're moving from the Apache 2 to the MIT license for the Bootstrap code (not the docs). Please see the [contributing guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md) for more information. ## Community Keep track of development and community news. -* Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap). -* Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com). -* Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/twitter-bootstrap) -* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel. +- Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap). +- Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com). +- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel. +- Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3)). ## Versioning -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. +For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible. Releases will be numbered with the following format: @@ -139,9 +146,9 @@ Releases will be numbered with the following format: And constructed with the following guidelines: -* Breaking backward compatibility bumps the major (and resets the minor and patch) -* New additions without breaking backward compatibility bumps the minor (and resets the patch) -* Bug fixes and misc changes bumps the patch +- Breaking backward compatibility **bumps the major** while resetting minor and patch +- New additions without breaking backward compatibility **bumps the minor** while resetting the patch +- Bug fixes and misc changes **bumps only the patch** For more information on SemVer, please visit <http://semver.org/>. @@ -151,16 +158,16 @@ For more information on SemVer, please visit <http://semver.org/>. **Mark Otto** -+ <http://twitter.com/mdo> -+ <http://github.com/mdo> +- <http://twitter.com/mdo> +- <http://github.com/mdo> **Jacob Thornton** -+ <http://twitter.com/fat> -+ <http://github.com/fat> +- <http://twitter.com/fat> +- <http://github.com/fat> ## Copyright and license -Copyright 2013 Twitter, Inc under [the Apache 2.0 license](LICENSE). +Code and documentation copyright 2011-2014 Twitter, Inc. Code released under [the MIT license](LICENSE). Docs released under [Creative Commons](docs/LICENSE). |