WebCompDev / COMPONENTS

Commit 6bb354e80cd248f6e17d2d258d1fb76c6b35208f

Authored by isisadmin
1 parent 0e620ae2

update readme

Inline Side-by-side
Showing 1 changed file with 138 additions and 0 deletions
README.md
  View file @6bb354e
  1 +# [Bootstrap](http://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 +[![Build Status](https://img.shields.io/travis/twbs/bootstrap/master.svg)](https://travis-ci.org/twbs/bootstrap)
  7 +[![devDependency Status](https://img.shields.io/david/dev/twbs/bootstrap.svg)](https://david-dm.org/twbs/bootstrap#info=devDependencies)
  8 +[![Selenium Test Status](https://saucelabs.com/browser-matrix/bootstrap.svg)](https://saucelabs.com/u/bootstrap)
  9 +
  10 +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.
  11 +
  12 +To get started, check out <http://getbootstrap.com>!
  13 +
  14 +
  15 +## Table of contents
  16 +
  17 +* [Quick start](#quick-start)
  18 +* [Bugs and feature requests](#bugs-and-feature-requests)
  19 +* [Documentation](#documentation)
  20 +* [Contributing](#contributing)
  21 +* [Community](#community)
  22 +* [Versioning](#versioning)
  23 +* [Creators](#creators)
  24 +* [Copyright and license](#copyright-and-license)
  25 +
  26 +
  27 +## Quick start
  28 +
  29 +Several quick start options are available:
  30 +
  31 +* [Download the latest release](https://github.com/twbs/bootstrap/archive/v3.3.5.zip).
  32 +* Clone the repo: `git clone https://github.com/twbs/bootstrap.git`.
  33 +* Install with [Bower](http://bower.io): `bower install bootstrap`.
  34 +* Install with [npm](https://www.npmjs.com): `npm install bootstrap`.
  35 +* Install with [Meteor](https://www.meteor.com): `meteor add twbs:bootstrap`.
  36 +* Install with [Composer](https://getcomposer.org): `composer require twbs/bootstrap`.
  37 +
  38 +Read the [Getting started page](http://getbootstrap.com/getting-started/) for information on the framework contents, templates and examples, and more.
  39 +
  40 +### What's included
  41 +
  42 +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:
  43 +
  44 +```
  45 +bootstrap/
  46 +├── css/
  47 +│ ├── bootstrap.css
  48 +│ ├── bootstrap.css.map
  49 +│ ├── bootstrap.min.css
  50 +│ ├── bootstrap.min.css.map
  51 +│ ├── bootstrap-theme.css
  52 +│ ├── bootstrap-theme.css.map
  53 +│ ├── bootstrap-theme.min.css
  54 +│ └── bootstrap-theme.min.css.map
  55 +├── js/
  56 +│ ├── bootstrap.js
  57 +│ └── bootstrap.min.js
  58 +└── fonts/
  59 + ├── glyphicons-halflings-regular.eot
  60 + ├── glyphicons-halflings-regular.svg
  61 + ├── glyphicons-halflings-regular.ttf
  62 + ├── glyphicons-halflings-regular.woff
  63 + └── glyphicons-halflings-regular.woff2
  64 +```
  65 +
  66 +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. Fonts from Glyphicons are included, as is the optional Bootstrap theme.
  67 +
  68 +
  69 +## Bugs and feature requests
  70 +
  71 +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).
  72 +
  73 +
  74 +## Documentation
  75 +
  76 +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.
  77 +
  78 +### Running documentation locally
  79 +
  80 +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x).
  81 + **Note for Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems.
  82 +2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`.
  83 +3. From the root `/bootstrap` directory, run `jekyll serve` in the command line.
  84 +4. Open `http://localhost:9001` in your browser, and voilà.
  85 +
  86 +Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).
  87 +
  88 +### Documentation for previous releases
  89 +
  90 +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.
  91 +
  92 +[Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download.
  93 +
  94 +
  95 +## Contributing
  96 +
  97 +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.
  98 +
  99 +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).
  100 +
  101 +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>.
  102 +
  103 +
  104 +## Community
  105 +
  106 +Get updates on Bootstrap's development and chat with the project maintainers and community members.
  107 +
  108 +* Follow [@getbootstrap on Twitter](https://twitter.com/getbootstrap).
  109 +* Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com).
  110 +* Join [the official Slack room](https://bootstrap-slack.herokuapp.com).
  111 +* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##bootstrap` channel.
  112 +* Implementation help may be found at Stack Overflow (tagged [`twitter-bootstrap-3`](https://stackoverflow.com/questions/tagged/twitter-bootstrap-3)).
  113 +* 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.
  114 +
  115 +
  116 +## Versioning
  117 +
  118 +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.
  119 +
  120 +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](http://blog.getbootstrap.com) contain summaries of the most noteworthy changes made in each release.
  121 +
  122 +
  123 +## Creators
  124 +
  125 +**Mark Otto**
  126 +
  127 +* <https://twitter.com/mdo>
  128 +* <https://github.com/mdo>
  129 +
  130 +**Jacob Thornton**
  131 +
  132 +* <https://twitter.com/fat>
  133 +* <https://github.com/fat>
  134 +
  135 +
  136 +## Copyright and license
  137 +
  138 +Code and documentation copyright 2011-2015 Twitter, Inc. 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 139 \ No newline at end of file
... ...