git.roojs.org Git - bootswatch/blob - bower_components/bootstrap/README.md

   1 # [Bootstrap](http://getbootstrap.com) [![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)](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 and maintained by [Mark Otto](http://twitter.com/mdo) and [Jacob Thornton](http://twitter.com/fat).
   5
   6 To get started, check out <http://getbootstrap.com>!
   7
   8
   9
  10 ## Quick start
  11
  12 Three quick start options are available:
  13
  14 * [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.0.3.zip).
  15 * Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
  16 * Install with [Bower](http://bower.io): `bower install bootstrap`.
  17
  18 Read the [Getting Started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
  19
  20 ### What's included
  21
  22 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:
  23
  24 ```
  25 bootstrap/
  26 ├── css/
  27 │   ├── bootstrap.css
  28 │   ├── bootstrap.min.css
  29 │   ├── bootstrap-theme.css
  30 │   └── bootstrap-theme.min.css
  31 ├── js/
  32 │   ├── bootstrap.js
  33 │   └── bootstrap.min.js
  34 └── fonts/
  35     ├── glyphicons-halflings-regular.eot
  36     ├── glyphicons-halflings-regular.svg
  37     ├── glyphicons-halflings-regular.ttf
  38     └── glyphicons-halflings-regular.woff
  39 ```
  40
  41 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.
  42
  43
  44
  45 ## Bugs and feature requests
  46
  47 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/).
  48
  49 You may use [this JS Bin](http://jsbin.com/aKiCIDO/1/edit) as a template for your bug reports.
  50
  51
  52
  53 ## Documentation
  54
  55 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.
  56
  57 ### Running documentation locally
  58
  59 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.x).
  60 2. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
  61   - **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.
  62 3. Open <http://localhost:9001> in your browser, and voilà.
  63
  64 Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
  65
  66 ### Documentation for previous releases
  67
  68 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.
  69
  70 [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
  71
  72
  73
  74 ## Compiling CSS and JavaScript
  75
  76 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.
  77
  78 ### Install Grunt
  79
  80 From the command line:
  81
  82 1. Install `grunt-cli` globally with `npm install -g grunt-cli`.
  83 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.
  84
  85 When completed, you'll be able to run the various Grunt commands provided from the command line.
  86
  87 **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.
  88
  89 ### Available Grunt commands
  90
  91 #### Build - `grunt`
  92 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/).**
  93
  94 #### Only compile CSS and JavaScript - `grunt dist`
  95 `grunt dist` creates the `/dist` directory with compiled files. **Uses [recess](http://twitter.github.io/recess/) and [UglifyJS](http://lisperator.net/uglifyjs/).**
  96
  97 #### Tests - `grunt test`
  98 Runs [JSHint](http://jshint.com) and [QUnit](http://qunitjs.com/) tests headlessly in [PhantomJS](http://phantomjs.org/) (used for CI).
  99
 100 #### Watch - `grunt watch`
 101 This is a convenience method for watching just Less files and automatically building them whenever you save.
 102
 103 ### Troubleshooting dependencies
 104
 105 Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun `npm install`.
 106
 107
 108
 109 ## Contributing
 110
 111 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.
 112
 113 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).
 114
 115 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>.
 116
 117 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.
 118
 119
 120 ## Community
 121
 122 Keep track of development and community news.
 123
 124 * Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap).
 125 * Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
 126 * Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/twitter-bootstrap)
 127 * Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel.
 128
 129
 130
 131
 132 ## Versioning
 133
 134 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.
 135
 136 Releases will be numbered with the following format:
 137
 138 `<major>.<minor>.<patch>`
 139
 140 And constructed with the following guidelines:
 141
 142 * Breaking backward compatibility bumps the major (and resets the minor and patch)
 143 * New additions without breaking backward compatibility bumps the minor (and resets the patch)
 144 * Bug fixes and misc changes bumps the patch
 145
 146 For more information on SemVer, please visit <http://semver.org/>.
 147
 148
 149
 150 ## Authors
 151
 152 **Mark Otto**
 153
 154 + <http://twitter.com/mdo>
 155 + <http://github.com/mdo>
 156
 157 **Jacob Thornton**
 158
 159 + <http://twitter.com/fat>
 160 + <http://github.com/fat>
 161
 162
 163
 164 ## Copyright and license
 165
 166 Copyright 2013 Twitter, Inc under [the Apache 2.0 license](LICENSE).