rooty/Bootstrap
0
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00
Code Issues Actions Packages Releases Activity
1421a0e9bb
Bootstrap/README.md

5.4 KiB
Raw Blame History

Bootstrap v3.0.0 Build Status

Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created and maintained by Mark Otto and Jacob Thornton.

To get started, check out http://getbootstrap.com!

Quick start

Three quick start options are available:

Read the Getting Started page for information on the framework contents, templates and examples, and more.

Bugs and feature requests

Have a bug or a feature request? Please open a new issue. Before opening any issue, please search for existing issues and read the Issue Guidelines, written by Nicolas Gallagher.

Documentation

Bootstrap's documentation, included in this repo in the /docs directory, is built with Jekyll and publicly hosted on GitHub Pages at http://getbootstrap.com. The docs maybe also be run locally.

Running documentation locally

  1. If necessary, install Jekyll.
  2. From the /bootstrap directory, run jekyll serve in the command line.
  3. Open http://getbootstrap.dev:9001 in your browser, and voilà.

Learn more about using Jekyll by reading their documentation.

Documentation for previous releases

Documentation for v2.3.2 has been made available for the time being at http://getbootstrap.com/2.3.2/docs while folks transition to Bootstrap 3.

For previous releases, documentation is available for download via Git tags.

Compiling CSS and JavaScript

Bootstrap includes a makefile with convenient methods for working with the framework. Before getting started, install the necessary local dependencies:

$ npm install

When completed, you'll be able to run the various make commands provided.

Available makefile commands

Build - make

make runs the Recess compiler to rebuild the /less files and compile the docs. Requires recess and uglify-js.

Compile CSS, JS, and fonts - make bootstrap

make bootstrap creates the /bootstrap directory with compiled files. Requires recess and uglify-js.

Tests - make test

Runs jshint and qunit tests headlessly in phantomjs (used for ci). Requires phantomjs.

Watch - make watch

This is a convenience method for watching just Less files and automatically building them whenever you save. Requires the watchr gem.

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running makefile commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Contributing

Please read through our guidelines for contributing to Bootstrap. Included are directions for opening issues, coding standards, and notes on development.

More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Community

Keep track of development and community news.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bumps the minor (and resets the patch)
  • Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.

Authors

Mark Otto

Jacob Thornton

Copyright and license

Copyright 2012 Twitter, Inc under the Apache 2.0 license.