kevan / todc-bootstrap Goto Github PK

• Overview
• Quick start
• Compatibility
• Requirements
• Bugs and feature requests
• Documentation
• Contributing
• Versioning
• Creators
• Copyright and license
• Acknowledgements

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. The project's goal isn't UI parity with Google Apps -- it's feature parity with Bootstrap, themed with Google's UI in mind.

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

Three quick start options are available:

• Download the latest release.
• Clone the repo: git clone https://github.com/todc/todc-bootstrap.git.
• Install with Bower: bower install todc-bootstrap.

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

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:

todc-bootstrap/
├── css/
│   ├── bootstrap.css
│   ├── bootstrap.css.map
│   ├── bootstrap.min.css
│   ├── bootstrap-theme.css
│   ├── bootstrap-theme.map
│   ├── bootstrap-theme.min.css
│   ├── todc-bootstrap.css
│   ├── todc-bootstrap.css.map
│   └── todc-bootstrap.min.css
├── js/
│   ├── bootstrap.js
│   └── bootstrap.min.js
├── fonts/
│   ├── glyphicons-halflings-regular.eot
│   ├── glyphicons-halflings-regular.svg
│   ├── glyphicons-halflings-regular.ttf
│   └── glyphicons-halflings-regular.woff
└── img/
    └── checkmark.png

We provide compiled CSS and JS (bootstrap.*, todc-bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*, todc-bootstrap.min.*). CSS source maps (bootstrap.*.map, todc-bootstrap.*.map) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.

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

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

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.

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

1. If necessary, install Jekyll (requires v2.5.x).

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

2. Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
3. From the root /todc-bootstrap directory, run jekyll serve in the command line.
4. Open http://localhost:9002 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Documentation for v2.3.2 has been made available for the time being at https://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.

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

Moreover, 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.

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/.

Tim O'Donnell

• https://github.com/todc

Copyright 2011-2014 Tim O'Donnell. Code released under the MIT license. Docs released under Creative Commons.

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.

Inspired by Bootstrap and, of course, Google.