mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00

Cyril Jouve b4f5687c05 fix README.md

2013-07-28 02:52:39 +02:00

6.0 KiB

Raw Blame History

Bootstrap v3.0.0

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:

Download the latest release.
Clone the repo: git clone git://github.com/twbs/bootstrap.git.
Install with Bower: bower install bootstrap.

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 root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://getbootstrap.com. The docs may also be run locally.

Running documentation locally

If necessary, install Jekyll (requires v1.x).
From the root /bootstrap directory, run jekyll serve in the command line.

Windows users: run chcp 65001 first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors.

Open http://localhost: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/ while folks transition to Bootstrap 3.

Previous releases and their documentation are also available for download.

Compiling CSS and JavaScript

Bootstrap uses Grunt with convenient methods for working with the framework. It's how we compile our code, run tests, and more. To use it, install the required dependencies as directed and then run some Grunt commands.

Install Grunt

From the command line:

Install grunt-cli globally with npm install -g grunt-cli.
Install the necessary local dependencies via npm install

When completed, you'll be able to run the various Grunt commands provided from the command line.

Unfamiliar with npm? Don't have node installed? That's a-okay. npm stands for node packaged modules and is a way to manage development dependencies through node.js. Download and install node.js before proceeding.

Available Grunt commands

Build - `grunt`

Run grunt to run tests locally and compile the CSS and JavaScript into /dist. Requires recess and uglify-js.

Only compile CSS and JavaScript - `grunt dist`

grunt dist creates the /dist directory with compiled files. Requires recess and uglify-js.

Tests - `grunt test`

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

Watch - `grunt watch`

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

Troubleshooting dependencies

Should you encounter problems with installing dependencies or running Grunt 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.

Follow @twbootstrap on Twitter.
Read and subscribe to the The Official Bootstrap Blog.
Have a question that's not a feature request or bug report? Ask on the mailing list.
Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##twitter-bootstrap channel.

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

6.0 KiB Raw Blame History