diff options
author | Baraa Hamodi <baraa@optimizely.com> | 2015-09-16 21:05:04 +0300 |
---|---|---|
committer | Chris Rebert <code@chrisrebert.com> | 2015-09-28 22:37:35 +0300 |
commit | 85bc0338d152102334f70f66a63403b93a50209f (patch) | |
tree | 6ccea311cd5d2bb34ca3e7dde98164c0b438e576 /README.md | |
parent | e38f066d8c203c3e032da0ff23cd2d6098ee2dd6 (diff) |
Documentation clean up and consistency; closes #17625
[skip sauce]
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 10 |
1 files changed, 3 insertions, 7 deletions
@@ -11,6 +11,7 @@ Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and To get started, check out <http://getbootstrap.com>! + ## Table of contents * [Quick start](#quick-start) @@ -22,6 +23,7 @@ To get started, check out <http://getbootstrap.com>! * [Creators](#creators) * [Copyright and license](#copyright-and-license) + ## Quick start Several quick start options are available: @@ -64,7 +66,6 @@ bootstrap/ 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. - ## Bugs and feature requests 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). @@ -76,7 +77,7 @@ Bootstrap's documentation, included in this repo in the root directory, is built ### Running documentation locally -1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x). +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.5.x). **Note for Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. 2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`. 3. From the root `/bootstrap` directory, run `jekyll serve` in the command line. @@ -91,7 +92,6 @@ Documentation for v2.3.2 has been made available for the time being at <http://g [Previous releases](https://github.com/twbs/bootstrap/releases) and their documentation are also available for download. - ## Contributing 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. @@ -101,7 +101,6 @@ Moreover, if your pull request contains JavaScript patches or features, you must 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>. - ## Community Get updates on Bootstrap's development and chat with the project maintainers and community members. @@ -114,7 +113,6 @@ Get updates on Bootstrap's development and chat with the project maintainers and * 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. - ## Versioning 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. @@ -122,7 +120,6 @@ For transparency into our release cycle and in striving to maintain backward com 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. - ## Creators **Mark Otto** @@ -136,7 +133,6 @@ See [the Releases section of our GitHub project](https://github.com/twbs/bootstr * <https://github.com/fat> - ## Copyright and license 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). |