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