diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 58 |
1 files changed, 36 insertions, 22 deletions
@@ -1,24 +1,24 @@ -# [Bootstrap](https://getbootstrap.com) +<p align="center"> + <a href="https://v4-alpha.getbootstrap.com"> + <img src="http://v4-alpha.getbootstrap.com/assets/brand/bootstrap-solid.svg" width=72 height=72> + </a> -[](https://bootstrap-slack.herokuapp.com) - -[](https://www.npmjs.com/package/bootstrap) -[](https://rubygems.org/gems/bootstrap) -[](https://travis-ci.org/twbs/bootstrap) -[](https://david-dm.org/twbs/bootstrap?type=dev) -[](https://atmospherejs.com/twbs/bootstrap) -[](https://packagist.org/packages/twbs/bootstrap) -[](https://www.nuget.org/packages/bootstrap/4.0.0-alpha5) - -[](https://saucelabs.com/u/bootstrap) + <h3 align="center">Bootstrap</h3> -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. + <p align="center"> + Sleek, intuitive, and powerful front-end framework for faster and easier web development. + <br> + <a href="https://v4-alpha.getbootstrap.com"><strong>Visit Bootstrap »</strong></a> + </p> +</p> -To get started, check out <https://getbootstrap.com>! +<br> ## Table of contents - [Quick start](#quick-start) +- [Status](#status) +- [What's included](#whats-included) - [Bugs and feature requests](#bugs-and-feature-requests) - [Documentation](#documentation) - [Contributing](#contributing) @@ -31,17 +31,31 @@ To get started, check out <https://getbootstrap.com>! Several quick start options are available: -- [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.0.0-alpha.5.zip) +- [Download the latest release.](https://github.com/twbs/bootstrap/archive/v4.0.0-alpha.6.zip) - Clone the repo: `git clone https://github.com/twbs/bootstrap.git` -- Install with [npm](https://www.npmjs.com): `npm install [email protected]` -- Install with [yarn](https://github.com/yarnpkg/yarn): `yarn add [email protected]` -- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap:4.0.0-alpha.5` -- Install with [Bower](https://bower.io): `bower install bootstrap#v4.0.0-alpha.5` +- Install with [npm](https://www.npmjs.com): `npm install [email protected]` +- Install with [yarn](https://github.com/yarnpkg/yarn): `yarn add [email protected]` +- Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap:4.0.0-alpha.6` +- Install with [Bower](https://bower.io): `bower install bootstrap#v4.0.0-alpha.6` - 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). Read the [Getting started page](https://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more. -### What's included +## Status + +[](https://bootstrap-slack.herokuapp.com) +[](https://bower.io/search/?q=bootstrap) +[](https://www.npmjs.com/package/bootstrap) +[](https://rubygems.org/gems/bootstrap) +[](https://travis-ci.org/twbs/bootstrap) +[](https://david-dm.org/twbs/bootstrap?type=dev) +[](https://atmospherejs.com/twbs/bootstrap) +[](https://packagist.org/packages/twbs/bootstrap) +[](https://www.nuget.org/packages/bootstrap/absoluteLatest) + +[](https://saucelabs.com/u/bootstrap) + +## What's included 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: @@ -57,7 +71,7 @@ bootstrap/ └── bootstrap.min.js ``` -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. +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. ## Bugs and feature requests @@ -72,7 +86,7 @@ Bootstrap's documentation, included in this repo in the root directory, is built ### Running documentation locally 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`. -2. Run `grunt` (or a specific set of Grunt tasks) to rebuild distributed CSS and JavaScript files, as well as our docs assets. +2. Run `npm run test` (or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. 3. From the root `/bootstrap` directory, run `bundle exec jekyll serve` in the command line. 4. Open <http://localhost:9001> in your browser, and voilà. |