Table of contents

• Overview
• Compatibility
• Requirements
• Bugs and feature requests
• Documentation
• Compiling CSS and JavaScript
• Contributing
• Versioning
• Authors
• Copyright and license
• Acknowledgements

Overview

This is a Google-styled theme for Bootstrap. Because I'm a fan of the new Google UI seen in Gmail, Docs, Calendar, etc, I decided to reproduce the look of these new UI elements for my own personal use.

TODC Bootstrap was created by Tim O'Donnell, and maintained with the support and involvement of the community.

Compatibility

This is being tested in the latest versions of Chrome, Firefox, and IE8+.

The following projects are specifically designed for use with todc-bootstrap:

• todc-select2 - Google-themed select menus
• todc-datepicker - Google-themed datepicker component

Requirements

• LESS - for compiling .less files into CSS
• Bootstrap - this will be automatically checked out, if necessary, during the build process

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

TODC Bootstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://todc.github.io/todc-bootstrap/>. The docs may also be run locally.

Running documentation locally

1. If necessary, install Jekyll (requires v1.x).

• Windows users: read this unofficial guide to get Jekyll up and running without problems.

2. From the root /todc-bootstrap directory, run jekyll serve in the command line.

• Windows users: For Ruby 2.0.0 run chcp 65001 first to change the command prompt's character encoding (code page) to UTF-8 so Jekyll runs without errors. For Ruby 1.9.3 you can alternatively do SET LANG=en_EN.UTF-8. In addition, ensure you have Python installed and added in your PATH or the build will fail due to our Pygments dependency.

3. Open http://localhost:9002 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for previous releases

Documentation for v2.3.2 has been made available for the time being at http://todc.github.io/todc-bootstrap/2.3.2/ while folks transition to TODC 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:

1. Install grunt-cli globally with npm install -g grunt-cli.
2. Navigate to the root /todc-bootstrap directory, then run npm install. npm will look at package.json and automatically install the necessary local dependencies listed there.

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

Get Bootstrap - grunt checkout-bootstrap

grunt checkout-bootstrap - clones Bootstrap and checks out the version specified by the bootstrapVersion variable in Gruntfile.js.

Build - grunt

Run grunt to run tests locally and compile the CSS and JavaScript into /dist. Uses Less and UglifyJS.

Only compile CSS and JavaScript - grunt dist

grunt dist creates the /dist directory with compiled files. Uses Less and UglifyJS.

Compress/zip - grunt compress

Run grunt compress - compresses/zips the contents of the /dist folder to todc-bootstrap-x.x.x-dist.zip in the /dist folder.

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 contributing guidelines. 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.

Versioning

TODC Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>-<major>.<minor>.<patch>

The first set of <major>.<minor>.<patch> is the Bootstrap version while the second set is the todc-bootstrap version.

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

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

Authors

Tim O'Donnell

• http://github.com/todc

Copyright and license

Copyright 2013 Tim O'Donnell under the MIT license.

NOTE This project was previously and incorrectly licensed under the Public Domain. It has now been changed to be compatible with Bootstrap's current license.

Acknowledgements

Inspired by Bootstrap and, of course, Google.