src/scss/bootstrap-4.0.0-alpha.6/README.md

   1 # [Bootstrap](https://getbootstrap.com)
   2
   3 [![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com)
   4 ![Bower version](https://img.shields.io/bower/v/bootstrap.svg)
   5 [![npm version](https://img.shields.io/npm/v/bootstrap.svg)](https://www.npmjs.com/package/bootstrap)
   6 [![Gem version](https://img.shields.io/gem/v/bootstrap.svg)](https://rubygems.org/gems/bootstrap)
   7 [![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg)](https://travis-ci.org/twbs/bootstrap)
   8 [![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap?type=dev)
   9 [![Meteor Atmosphere](https://img.shields.io/badge/meteor-twbs%3Abootstrap-blue.svg)](https://atmospherejs.com/twbs/bootstrap)
  10 [![Packagist Prerelease](https://img.shields.io/packagist/vpre/twbs/bootstrap.svg)](https://packagist.org/packages/twbs/bootstrap)
  11 [![NuGet](https://img.shields.io/nuget/vpre/bootstrap.svg)](https://www.nuget.org/packages/bootstrap/4.0.0-alpha5)
  12
  13 [![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
  14
  15 Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by [Mark Otto](https://twitter.com/mdo) and [Jacob Thornton](https://twitter.com/fat), and maintained by the [core team](https://github.com/orgs/twbs/people) with the massive support and involvement of the community.
  16
  17 To get started, check out <https://getbootstrap.com>!
  18
  19 ## Table of contents
  20
  21 - [Quick start](#quick-start)
  22 - [Bugs and feature requests](#bugs-and-feature-requests)
  23 - [Documentation](#documentation)
  24 - [Contributing](#contributing)
  25 - [Community](#community)
  26 - [Versioning](#versioning)
  27 - [Creators](#creators)
  28 - [Copyright and license](#copyright-and-license)
  29
  30 ## Quick start
  31
  32 Several quick start options are available:
  33
  34 - [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.0.0-alpha.6.zip)
  35 - Clone the repo: `git clone https://github.com/twbs/bootstrap.git`
  36 - Install with [npm](https://www.npmjs.com): `npm install bootstrap@4.0.0-alpha.6`
  37 - Install with [yarn](https://github.com/yarnpkg/yarn): `yarn add bootstrap@4.0.0-alpha.6`
  38 - Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap:4.0.0-alpha.6`
  39 - Install with [Bower](https://bower.io): `bower install bootstrap#v4.0.0-alpha.6`
  40 - Install with [NuGet](https://www.nuget.org): CSS: `Install-Package bootstrap -Pre` Sass: `Install-Package bootstrap.sass -Pre` (`-Pre` is only required until Bootstrap v4 has a stable release).
  41
  42 Read the [Getting started page](https://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
  43
  44 ### What's included
  45
  46 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:
  47
  48 ```
  49 bootstrap/
  50 ├── css/
  51 │   ├── bootstrap.css
  52 │   ├── bootstrap.css.map
  53 │   ├── bootstrap.min.css
  54 │   └── bootstrap.min.css.map
  55 └── js/
  56     ├── bootstrap.js
  57     └── bootstrap.min.js
  58 ```
  59
  60 We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developer.chrome.com/devtools/docs/css-preprocessors) (`bootstrap.*.map`) are available for use with certain browsers' developer tools.
  61
  62
  63 ## Bugs and feature requests
  64
  65 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).
  66
  67
  68 ## Documentation
  69
  70 Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](https://jekyllrb.com) and publicly hosted on GitHub Pages at <https://getbootstrap.com>. The docs may also be run locally.
  71
  72 ### Running documentation locally
  73
  74 1. Run through the [tooling setup](https://github.com/twbs/bootstrap/blob/v4-dev/docs/getting-started/build-tools.md#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
  75 2. Run `grunt` (or a specific set of Grunt tasks) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
  76 3. From the root `/bootstrap` directory, run `bundle exec jekyll serve` in the command line.
  77 4. Open <http://localhost:9001> in your browser, and voilà.
  78
  79 Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/home/).
  80
  81 ### Documentation for previous releases
  82
  83 Documentation for v2.3.2 has been made available for the time being at <https://getbootstrap.com/2.3.2/> while folks transition to Bootstrap 3.
  84
  85 [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
  86
  87
  88
  89 ## Contributing
  90
  91 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.
  92
  93 Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/twbs/bootstrap/tree/master/js/tests). All HTML and CSS should conform to the [Code Guide](https://github.com/mdo/code-guide), maintained by [Mark Otto](https://github.com/mdo).
  94
  95 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>.
  96
  97
  98
  99 ## Community
 100
 101 Get updates on Bootstrap's development and chat with the project maintainers and community members.
 102
 103 - Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
 104 - Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com).
 105 - Join [the official Slack room](https://bootstrap-slack.herokuapp.com).
 106 - Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
 107 - Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)).
 108 - Developers should use the keyword `bootstrap` on packages which modify or add to the functionality of Bootstrap when distributing through [npm](https://www.npmjs.com/browse/keyword/bootstrap) or similar delivery mechanisms for maximum discoverability.
 109
 110
 111
 112 ## Versioning
 113
 114 For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under [the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible.
 115
 116 See [the Releases section of our GitHub project](https://github.com/twbs/bootstrap/releases) for changelogs for each release version of Bootstrap. Release announcement posts on [the official Bootstrap blog](https://blog.getbootstrap.com) contain summaries of the most noteworthy changes made in each release.
 117
 118
 119 ## Creators
 120
 121 **Mark Otto**
 122
 123 - <https://twitter.com/mdo>
 124 - <https://github.com/mdo>
 125
 126 **Jacob Thornton**
 127
 128 - <https://twitter.com/fat>
 129 - <https://github.com/fat>
 130
 131
 132
 133 ## Copyright and license
 134
 135 Code and documentation copyright 2011-2017 the [Bootstrap Authors](https://github.com/twbs/bootstrap/graphs/contributors) and [Twitter, Inc.](https://twitter.com) Code released under the [MIT License](https://github.com/twbs/bootstrap/blob/master/LICENSE). Docs released under [Creative Commons](https://github.com/twbs/bootstrap/blob/master/docs/LICENSE).