|
| 1 | +<p align="center"> |
| 2 | + <a href="https://v4-alpha.getbootstrap.com"> |
| 3 | + <img src="http://v4-alpha.getbootstrap.com/assets/brand/bootstrap-solid.svg" width=72 height=72> |
| 4 | + </a> |
| 5 | + |
| 6 | + <h3 align="center">Bootstrap</h3> |
| 7 | + |
| 8 | + <p align="center"> |
| 9 | + Sleek, intuitive, and powerful front-end framework for faster and easier web development. |
| 10 | + <br> |
| 11 | + <a href="https://v4-alpha.getbootstrap.com"><strong>Explore Bootstrap docs »</strong></a> |
| 12 | + <br> |
| 13 | + <br> |
| 14 | + <a href="https://themes.getbootstrap.com">Bootstrap Themes</a> |
| 15 | + · |
| 16 | + <a href="https://jobs.getbootstrap.com">Job Board</a> |
| 17 | + · |
| 18 | + <a href="https://blog.getbootstrap.com">Blog</a> |
| 19 | + </p> |
| 20 | +</p> |
| 21 | + |
| 22 | +<br> |
| 23 | + |
| 24 | +## Table of contents |
| 25 | + |
| 26 | +- [Quick start](#quick-start) |
| 27 | +- [Status](#status) |
| 28 | +- [What's included](#whats-included) |
| 29 | +- [Bugs and feature requests](#bugs-and-feature-requests) |
| 30 | +- [Documentation](#documentation) |
| 31 | +- [Contributing](#contributing) |
| 32 | +- [Community](#community) |
| 33 | +- [Versioning](#versioning) |
| 34 | +- [Creators](#creators) |
| 35 | +- [Copyright and license](#copyright-and-license) |
| 36 | + |
| 37 | +## Quick start |
| 38 | + |
| 39 | +Several quick start options are available: |
| 40 | + |
| 41 | +- [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.0.0-beta.zip) |
| 42 | +- Clone the repo: `git clone https://github.com/twbs/bootstrap.git` |
| 43 | +- Install with [npm ](https://www.npmjs.com): `npm install [email protected]` |
| 44 | +- Install with [yarn ](https://github.com/yarnpkg/yarn): `yarn add [email protected]` |
| 45 | +- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap:4.0.0-beta` |
| 46 | +- Install with [Bower](https://bower.io): `bower install bootstrap#v4.0.0-beta` |
| 47 | +- 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). |
| 48 | + |
| 49 | +Read the [Getting started page](https://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more. |
| 50 | + |
| 51 | +## Status |
| 52 | + |
| 53 | +[](https://bootstrap-slack.herokuapp.com) |
| 54 | +[](https://bower.io/search/?q=bootstrap) |
| 55 | +[](https://www.npmjs.com/package/bootstrap) |
| 56 | +[](https://rubygems.org/gems/bootstrap) |
| 57 | +[](https://travis-ci.org/twbs/bootstrap) |
| 58 | +[](https://david-dm.org/twbs/bootstrap?type=dev) |
| 59 | +[](https://atmospherejs.com/twbs/bootstrap) |
| 60 | +[](https://packagist.org/packages/twbs/bootstrap) |
| 61 | +[](https://www.nuget.org/packages/bootstrap/absoluteLatest) |
| 62 | + |
| 63 | +[](https://saucelabs.com/u/bootstrap) |
| 64 | + |
| 65 | +## What's included |
| 66 | + |
| 67 | +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: |
| 68 | + |
| 69 | +``` |
| 70 | +bootstrap/ |
| 71 | +├── css/ |
| 72 | +│ ├── bootstrap.css |
| 73 | +│ ├── bootstrap.css.map |
| 74 | +│ ├── bootstrap.min.css |
| 75 | +│ └── bootstrap.min.css.map |
| 76 | +└── js/ |
| 77 | + ├── bootstrap.js |
| 78 | + └── bootstrap.min.js |
| 79 | +``` |
| 80 | + |
| 81 | +We provide compiled CSS and JS (`bootstrap.*`), as well as compiled and minified CSS and JS (`bootstrap.min.*`). CSS [source maps](https://developers.google.com/web/tools/chrome-devtools/debug/readability/source-maps) (`bootstrap.*.map`) are available for use with certain browsers' developer tools. |
| 82 | + |
| 83 | + |
| 84 | +## Bugs and feature requests |
| 85 | + |
| 86 | +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). |
| 87 | + |
| 88 | + |
| 89 | +## Documentation |
| 90 | + |
| 91 | +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. |
| 92 | + |
| 93 | +Documentation search is powered by [Algolia's DocSearch](https://community.algolia.com/docsearch/). Working on our search? Be sure to set `debug: true` in the `_scripts.html` include. |
| 94 | + |
| 95 | +### Running documentation locally |
| 96 | + |
| 97 | +1. Run through the [tooling setup](https://github.com/twbs/bootstrap/blob/v4-dev/docs/4.0/getting-started/build-tools.md#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`. |
| 98 | +2. Run `npm run test` (or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. |
| 99 | +3. From the root `/bootstrap` directory, run `bundle exec jekyll serve` in the command line. |
| 100 | +4. Open <http://localhost:9001> in your browser, and voilà. |
| 101 | + |
| 102 | +Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/home/). |
| 103 | + |
| 104 | +### Documentation for previous releases |
| 105 | + |
| 106 | +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. |
| 107 | + |
| 108 | +[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download. |
| 109 | + |
| 110 | + |
| 111 | + |
| 112 | +## Contributing |
| 113 | + |
| 114 | +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. |
| 115 | + |
| 116 | +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). |
| 117 | + |
| 118 | +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>. |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | +## Community |
| 123 | + |
| 124 | +Get updates on Bootstrap's development and chat with the project maintainers and community members. |
| 125 | + |
| 126 | +- Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap). |
| 127 | +- Read and subscribe to [The Official Bootstrap Blog](https://blog.getbootstrap.com). |
| 128 | +- Join [the official Slack room](https://bootstrap-slack.herokuapp.com). |
| 129 | +- Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel. |
| 130 | +- Implementation help may be found at Stack Overflow (tagged [`bootstrap-4`](https://stackoverflow.com/questions/tagged/bootstrap-4)). |
| 131 | +- 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. |
| 132 | + |
| 133 | + |
| 134 | + |
| 135 | +## Versioning |
| 136 | + |
| 137 | +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. |
| 138 | + |
| 139 | +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. |
| 140 | + |
| 141 | + |
| 142 | +## Creators |
| 143 | + |
| 144 | +**Mark Otto** |
| 145 | + |
| 146 | +- <https://twitter.com/mdo> |
| 147 | +- <https://github.com/mdo> |
| 148 | + |
| 149 | +**Jacob Thornton** |
| 150 | + |
| 151 | +- <https://twitter.com/fat> |
| 152 | +- <https://github.com/fat> |
| 153 | + |
| 154 | + |
| 155 | + |
| 156 | +## Copyright and license |
| 157 | + |
| 158 | +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). |
0 commit comments