Update README to match master branch version
Sérgio Gomes
GitHub
parent
2009b7d208
commit
e6e8dfc844
135
README.md
135
README.md
|
|
@ -7,20 +7,33 @@
|
|||
[](https://david-dm.org/google/material-design-lite)
|
||||
|
||||
> An implementation of [Material Design](http://www.google.com/design/spec/material-design/introduction.html)
|
||||
components in vanilla CSS, JS, and HTML
|
||||
components in vanilla CSS, JS, and HTML.
|
||||
|
||||
Material Design Lite (MDL) lets you add a Material Design look and feel to your
|
||||
static content websites. It doesn't rely on any JavaScript frameworks or
|
||||
libraries. Optimized for cross-device use, gracefully degrades in older
|
||||
browsers, and offers an experience that is accessible from the get-go.
|
||||
|
||||
## Want to contribute?
|
||||
|
||||
If you found a bug, have any questions or want to contribute. Follow our
|
||||
[guidelines](https://github.com/google/material-design-lite/blob/master/CONTRIBUTING.md),
|
||||
and help improve the Material Design Lite. For more information visit our
|
||||
[wiki](https://github.com/google/material-design-lite/wiki).
|
||||
|
||||
If you are submitting a bug fix or a new component for the 1.x line, please send those into `mdl-1.x` currently.
|
||||
|
||||
The `master` branch is where we are working on 2.0.
|
||||
It is currently **highly** experimental and no support building or using it will be provided.
|
||||
|
||||
## Use MDL on your site?
|
||||
|
||||
**This document is targeted at developers that will contribute to or compile
|
||||
MDL. If you are looking to use MDL on your website or web app please head to
|
||||
[getmdl.io](http://getmdl.io).**
|
||||
|
||||
## Browser Support
|
||||
## Browser Support in v1
|
||||
|
||||
|
||||
| IE9 | IE10 | IE11 | Chrome | Opera | Firefox | Safari | Chrome (Android) | Mobile Safari |
|
||||
|-----|------|------|--------|-------|---------|--------|------------------|---------------|
|
||||
|
|
@ -29,7 +42,20 @@ MDL. If you are looking to use MDL on your website or web app please head to
|
|||
A-grade browsers are fully supported. B-grade browsers will gracefully degrade
|
||||
to our CSS-only experience.
|
||||
|
||||
## Getting Started
|
||||
## Browser Support in v2 (in development)
|
||||
|
||||
Supported evergreen browsers:
|
||||
|
||||
- Chrome
|
||||
- Edge
|
||||
- Firefox
|
||||
- Opera
|
||||
|
||||
Supported versioned browsers:
|
||||
|
||||
- Internet Explorer 11
|
||||
- Safari 8
|
||||
- Mobile Safari 8
|
||||
|
||||
### Download / Clone
|
||||
|
||||
|
|
@ -46,7 +72,7 @@ Windows users, if you have trouble compiling due to line endings then make sure
|
|||
you configure git to checkout the repository with `lf` (unix) line endings. This
|
||||
can be achieved by setting `core.eol`.
|
||||
|
||||
```
|
||||
```bash
|
||||
git config core.eol lf
|
||||
git config core.autocrlf input
|
||||
git rm --cached -r .
|
||||
|
|
@ -56,92 +82,6 @@ git reset --hard
|
|||
> Remember, the master branch is considered unstable. Do not use this in
|
||||
production. Use a tagged state of the repository, npm, or bower for stability!
|
||||
|
||||
### What's included
|
||||
|
||||
In the repo you'll find the following directories and files.
|
||||
|
||||
| File/Folder | Provides |
|
||||
|-----------------|------------------------------------------------|
|
||||
| CONTRIBUTING.md | MDL contribution guidelines. |
|
||||
| docs | Files for the documentation site. |
|
||||
| gulpfile.js | gulp configuration for MDL. |
|
||||
| LICENSE | Project license information. |
|
||||
| package.json | npm package information. |
|
||||
| README.md | Details for quickly understanding the project. |
|
||||
| src | Source code for MDL components. |
|
||||
| templates | Example templates. |
|
||||
| test | Project test files. |
|
||||
|
||||
### Build
|
||||
|
||||
To get started modifying the components or the docs, first install the necessary
|
||||
dependencies, from the root of the project:
|
||||
|
||||
```bash
|
||||
npm install && npm install -g gulp
|
||||
```
|
||||
|
||||
> MDL requires NodeJS 0.12.
|
||||
|
||||
Next, run the following one-liner to compile the components and the docs and
|
||||
spawn a local instance of the documentation site:
|
||||
|
||||
```bash
|
||||
gulp all && gulp serve
|
||||
```
|
||||
|
||||
Most changes made to files inside the `src` or the `docs` directory will cause
|
||||
the page to reload. This page can also be loaded up on physical devices thanks
|
||||
to BrowserSync.
|
||||
|
||||
To build a production version of the components, run:
|
||||
|
||||
```bash
|
||||
gulp
|
||||
```
|
||||
|
||||
This will clean the `dist` folder and rebuild the assets for serving.
|
||||
|
||||
### Templates
|
||||
|
||||
The `templates/` subdirectory contains a few exemplary usages of MDL. Templates
|
||||
have their own, quasi-separate gulp pipeline and can be compiled with
|
||||
`gulp templates`. The templates use the vanilla MDL JS and
|
||||
[themed](http://www.getmdl.io/customize/index.html) CSS files. Extraneous styles
|
||||
are kept in a separate CSS file. Use `gulp serve` to take a look at the
|
||||
templates:
|
||||
|
||||
* [Blog Template](http://www.getmdl.io/templates/blog)
|
||||
* [Dashboard Template](http://www.getmdl.io/templates/dashboard)
|
||||
* [Text Heavy Webpage Template](http://www.getmdl.io/templates/text-only)
|
||||
* [Stand Alone Article Template](http://www.getmdl.io/templates/article)
|
||||
* [Android.com MDL Skin Template](http://www.getmdl.io/templates/android-dot-com)
|
||||
* [Portfolio Template](http://www.getmdl.io/templates/portfolio)
|
||||
|
||||
> Templates are not officially supported in IE9 and legacy browsers that do not
|
||||
pass the minimum-requirements defined in our
|
||||
[cutting-the-mustard test](https://github.com/google/material-design-lite/blob/87c48c22416c3e83850f7711365b2a43ba19c5ce/src/mdlComponentHandler.js#L336-L349).
|
||||
|
||||
The templates refer to CDN hosted versions of the libraries. If you'd like to
|
||||
test the templates against locally built MDL libraries you need to run the
|
||||
`templates:localtestingoverride` gulp task before running `gulp serve`:
|
||||
|
||||
```bash
|
||||
gulp all && gulp templates:localtestingoverride && gulp serve
|
||||
```
|
||||
|
||||
> Beware as any changes to the `templates` directory will automatically revert
|
||||
the templates local testing overrides. In this case make sure you run the
|
||||
`templates:localtestingoverride` gulp task again or modify the `watch()`
|
||||
function in the gulp file.
|
||||
|
||||
## Versioning
|
||||
|
||||
For transparency into our release cycle and in striving to maintain backward
|
||||
compatibility, Material Design Lite is maintained under
|
||||
[the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up,
|
||||
but we'll adhere to those rules whenever possible.
|
||||
|
||||
## Feature requests
|
||||
|
||||
If you find MDL doesn't contain a particular component you think would be
|
||||
|
|
@ -151,21 +91,6 @@ Please keep in mind that one of the goals of MDL is to adhere to the Material
|
|||
Design specs and therefore some requests might not be within the scope of this
|
||||
project.
|
||||
|
||||
## Want to contribute?
|
||||
|
||||
If you found a bug, have any questions or want to contribute. Follow our
|
||||
[guidelines](https://github.com/google/material-design-lite/blob/master/CONTRIBUTING.md),
|
||||
and help improve the Material Design Lite. For more information visit our
|
||||
[wiki](https://github.com/google/material-design-lite/wiki).
|
||||
|
||||
## Do you include any features that a framework comes with?
|
||||
|
||||
Material Design Lite is focused on delivering a vanilla CSS/JS/HTML library of
|
||||
components. We are not a framework. If you are building a single-page app and
|
||||
require features like two-way data-binding, templating, CSS scoping and so
|
||||
forth, we recommend trying out the excellent
|
||||
[Polymer](http://polymer-project.org) project.
|
||||
|
||||
## License
|
||||
|
||||
© Google, 2015. Licensed under an
|
||||
|
|
|
|||
Loading…
Reference in New Issue