Skip to content
This repository has been archived by the owner on Aug 11, 2020. It is now read-only.

Latest commit

 

History

History
96 lines (60 loc) · 5.24 KB

README.md

File metadata and controls

96 lines (60 loc) · 5.24 KB
Raw

M8tro Bootstrap Theme

Bower npm Travis David npm

Bootstrap theme inspired by Windows Phone's Modern UI (aka “Metro”)

Watch a live demo!

Fonts

This theme was created with Modern UI's Segoe font-family in mind. While this commercial font is largely available on the Windows platform (Windows Phone, Windows Vista and later), system-default fonts will be used as fallback on other platforms.

Font Platform
Segoe UI Windows Vista (or later), Windows Phone 7 (or later)
Roboto Condensed Android, Web font (optional)
Fira Sans Firefox OS, Web font (optional)
Neue Helvetica iOS, Mac OS X

Installation

Style-sheets are meant to be used instead of bootstrap.min.css, there's no need to include both files.

Package Managers

Pre-compiled CSS files can be installed using Bower or npm:

# Install from Bower
bower install m8tro-bootstrap

# Install from npm
npm install m8tro-bootstrap

CDN

As of version 3.3.2, the style-sheet is hosted various content delivery networks (CDN). Serving files via SSL is encouraged, though you can always use schemeless URLs as well.

Service URL
cdnjs https://cdnjs.cloudflare.com/ajax/libs/m8tro-bootstrap/3.3.7/m8tro.min.css
jsDelivr https://cdn.jsdelivr.net/bootstrap.m8tro/3.3.7/m8tro.min.css

Note: It is not advised to embed a link to the raw file hosted on GitHub.

Manual Installation

Use the style-sheet from a release or download the latest development version of m8tro.min.css.

Developers

Gulp task

The provided gulpfile.js will serve as our primary build tool. In order to use it, you need to have Node.js and Gulp installed.

Once set up, install all required Node packages:

yarn || npm install

Several gulp tasks are now available:

Task Description
make build M8tro theme
setup choose Bootstrap components & build M8tro theme
clean delete contents of distribution folder
lint lint included LESS and JavaScript files

A special case is building the theme for Bootstrap Listr, which only uses a subset of Bootstrap's features. To do so use gulp setup --listr. The resulting CSS will be half the size, the JavaScript about a twelfth.

Customize

This repository includes templates for Chris Kempson's Base16 Builder, which you can use to create your own color schemes.

Contribute

Anybody can contribute new features and bug fixes by cloning the repository, and then sending a pull request.

License

The MIT License (MIT)

Copyright (c) 2014-2017 Jan T. Sott

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.