github.com/kayoticsully/syncthing@v0.8.9-0.20140724133906-c45a2fdc03f8/assets/bootstrap-3.1.1/README.md (about)

     1  # [Bootstrap](http://getbootstrap.com) [![Bower version](https://badge.fury.io/bo/bootstrap.png)](http://badge.fury.io/bo/bootstrap) [![Build Status](https://secure.travis-ci.org/twbs/bootstrap.png)](http://travis-ci.org/twbs/bootstrap) [![devDependency Status](https://david-dm.org/twbs/bootstrap/dev-status.png?theme=shields.io)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
     2  [![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
     3  
     4  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.
     5  
     6  To get started, check out <http://getbootstrap.com>!
     7  
     8  ## Table of contents
     9  
    10   - [Quick start](#quick-start)
    11   - [Bugs and feature requests](#bugs-and-feature-requests)
    12   - [Documentation](#documentation)
    13   - [Compiling CSS and JavaScript](#compiling-css-and-javascript)
    14   - [Contributing](#contributing)
    15   - [Community](#community)
    16   - [Versioning](#versioning)
    17   - [Authors](#authors)
    18   - [Copyright and license](#copyright-and-license)
    19  
    20  ## Quick start
    21  
    22  Three quick start options are available:
    23  
    24  - [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.1.1.zip).
    25  - Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
    26  - Install with [Bower](http://bower.io): `bower install bootstrap`.
    27  
    28  Read the [Getting Started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
    29  
    30  ### What's included
    31  
    32  Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
    33  
    34  ```
    35  bootstrap/
    36  ├── css/
    37  │   ├── bootstrap.css
    38  │   ├── bootstrap.min.css
    39  │   ├── bootstrap-theme.css
    40  │   └── bootstrap-theme.min.css
    41  ├── js/
    42  │   ├── bootstrap.js
    43  │   └── bootstrap.min.js
    44  └── fonts/
    45      ├── glyphicons-halflings-regular.eot
    46      ├── glyphicons-halflings-regular.svg
    47      ├── glyphicons-halflings-regular.ttf
    48      └── glyphicons-halflings-regular.woff
    49  ```
    50  
    51  We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). Fonts from Glyphicons are included, as is the optional Bootstrap theme.
    52  
    53  
    54  
    55  ## Bugs and feature requests
    56  
    57  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).
    58  
    59  
    60  ## Documentation
    61  
    62  Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at <http://getbootstrap.com>. The docs may also be run locally.
    63  
    64  ### Running documentation locally
    65  
    66  1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.x).
    67    - **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.
    68  2. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
    69    - **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`.
    70  3. Open <http://localhost:9001> in your browser, and voilà.
    71  
    72  Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
    73  
    74  ### Documentation for previous releases
    75  
    76  Documentation for v2.3.2 has been made available for the time being at <http://getbootstrap.com/2.3.2/> while folks transition to Bootstrap 3.
    77  
    78  [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
    79  
    80  
    81  
    82  ## Compiling CSS and JavaScript
    83  
    84  Bootstrap uses [Grunt](http://gruntjs.com/) with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.
    85  
    86  ### Install Grunt
    87  
    88  From the command line:
    89  
    90  1. Install `grunt-cli` globally with `npm install -g grunt-cli`.
    91  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.
    92  
    93  When completed, you'll be able to run the various Grunt commands provided from the command line.
    94  
    95  **Unfamiliar with `npm`? Don't have node installed?** That's a-okay. npm stands for [node packaged modules](http://npmjs.org/) and is a way to manage development dependencies through node.js. [Download and install node.js](http://nodejs.org/download/) before proceeding.
    96  
    97  ### Available Grunt commands
    98  
    99  #### Build - `grunt`
   100  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/).**
   101  
   102  #### Only compile CSS and JavaScript - `grunt dist`
   103  `grunt dist` creates the `/dist` directory with compiled files. **Uses [Less](http://lesscss.org/) and [UglifyJS](http://lisperator.net/uglifyjs/).**
   104  
   105  #### Tests - `grunt test`
   106  Runs [JSHint](http://jshint.com) and [QUnit](http://qunitjs.com/) tests headlessly in [PhantomJS](http://phantomjs.org/) (used for CI).
   107  
   108  #### Watch - `grunt watch`
   109  This is a convenience method for watching just Less files and automatically building them whenever you save.
   110  
   111  ### Troubleshooting dependencies
   112  
   113  Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`.
   114  
   115  
   116  
   117  ## Contributing
   118  
   119  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.
   120  
   121  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).
   122  
   123  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>.
   124  
   125  
   126  
   127  ## Community
   128  
   129  Keep track of development and community news.
   130  
   131  - Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap).
   132  - Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
   133  - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
   134  - Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](http://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
   135  
   136  
   137  
   138  
   139  ## Versioning
   140  
   141  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.
   142  
   143  Releases will be numbered with the following format:
   144  
   145  `<major>.<minor>.<patch>`
   146  
   147  And constructed with the following guidelines:
   148  
   149  - Breaking backward compatibility **bumps the major** while resetting minor and patch
   150  - New additions without breaking backward compatibility **bumps the minor** while resetting the patch
   151  - Bug fixes and misc changes **bumps only the patch**
   152  
   153  For more information on SemVer, please visit <http://semver.org/>.
   154  
   155  
   156  
   157  ## Authors
   158  
   159  **Mark Otto**
   160  
   161  - <http://twitter.com/mdo>
   162  - <http://github.com/mdo>
   163  
   164  **Jacob Thornton**
   165  
   166  - <http://twitter.com/fat>
   167  - <http://github.com/fat>
   168  
   169  
   170  
   171  ## Copyright and license
   172  
   173  Code and documentation copyright 2011-2014 Twitter, Inc. Code released under [the MIT license](LICENSE). Docs released under [Creative Commons](docs/LICENSE).