Skip to content

Commit e6e8dfc

Browse files
authored
Update README to match master branch version
1 parent 2009b7d commit e6e8dfc

1 file changed

Lines changed: 30 additions & 105 deletions

File tree

README.md

Lines changed: 30 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,33 @@
77
[![Dependency Status](https://david-dm.org/google/material-design-lite.svg)](https://david-dm.org/google/material-design-lite)
88

99
> An implementation of [Material Design](http://www.google.com/design/spec/material-design/introduction.html)
10-
components in vanilla CSS, JS, and HTML
10+
components in vanilla CSS, JS, and HTML.
1111

1212
Material Design Lite (MDL) lets you add a Material Design look and feel to your
1313
static content websites. It doesn't rely on any JavaScript frameworks or
1414
libraries. Optimized for cross-device use, gracefully degrades in older
1515
browsers, and offers an experience that is accessible from the get-go.
1616

17+
## Want to contribute?
18+
19+
If you found a bug, have any questions or want to contribute. Follow our
20+
[guidelines](https://github.com/google/material-design-lite/blob/master/CONTRIBUTING.md),
21+
and help improve the Material Design Lite. For more information visit our
22+
[wiki](https://github.com/google/material-design-lite/wiki).
23+
24+
If you are submitting a bug fix or a new component for the 1.x line, please send those into `mdl-1.x` currently.
25+
26+
The `master` branch is where we are working on 2.0.
27+
It is currently **highly** experimental and no support building or using it will be provided.
28+
1729
## Use MDL on your site?
1830

1931
**This document is targeted at developers that will contribute to or compile
2032
MDL. If you are looking to use MDL on your website or web app please head to
2133
[getmdl.io](http://getmdl.io).**
2234

23-
## Browser Support
35+
## Browser Support in v1
36+
2437

2538
| IE9 | IE10 | IE11 | Chrome | Opera | Firefox | Safari | Chrome (Android) | Mobile Safari |
2639
|-----|------|------|--------|-------|---------|--------|------------------|---------------|
@@ -29,7 +42,20 @@ MDL. If you are looking to use MDL on your website or web app please head to
2942
A-grade browsers are fully supported. B-grade browsers will gracefully degrade
3043
to our CSS-only experience.
3144

32-
## Getting Started
45+
## Browser Support in v2 (in development)
46+
47+
Supported evergreen browsers:
48+
49+
- Chrome
50+
- Edge
51+
- Firefox
52+
- Opera
53+
54+
Supported versioned browsers:
55+
56+
- Internet Explorer 11
57+
- Safari 8
58+
- Mobile Safari 8
3359

3460
### Download / Clone
3561

@@ -46,7 +72,7 @@ Windows users, if you have trouble compiling due to line endings then make sure
4672
you configure git to checkout the repository with `lf` (unix) line endings. This
4773
can be achieved by setting `core.eol`.
4874

49-
```
75+
```bash
5076
git config core.eol lf
5177
git config core.autocrlf input
5278
git rm --cached -r .
@@ -56,92 +82,6 @@ git reset --hard
5682
> Remember, the master branch is considered unstable. Do not use this in
5783
production. Use a tagged state of the repository, npm, or bower for stability!
5884

59-
### What's included
60-
61-
In the repo you'll find the following directories and files.
62-
63-
| File/Folder | Provides |
64-
|-----------------|------------------------------------------------|
65-
| CONTRIBUTING.md | MDL contribution guidelines. |
66-
| docs | Files for the documentation site. |
67-
| gulpfile.js | gulp configuration for MDL. |
68-
| LICENSE | Project license information. |
69-
| package.json | npm package information. |
70-
| README.md | Details for quickly understanding the project. |
71-
| src | Source code for MDL components. |
72-
| templates | Example templates. |
73-
| test | Project test files. |
74-
75-
### Build
76-
77-
To get started modifying the components or the docs, first install the necessary
78-
dependencies, from the root of the project:
79-
80-
```bash
81-
npm install && npm install -g gulp
82-
```
83-
84-
> MDL requires NodeJS 0.12.
85-
86-
Next, run the following one-liner to compile the components and the docs and
87-
spawn a local instance of the documentation site:
88-
89-
```bash
90-
gulp all && gulp serve
91-
```
92-
93-
Most changes made to files inside the `src` or the `docs` directory will cause
94-
the page to reload. This page can also be loaded up on physical devices thanks
95-
to BrowserSync.
96-
97-
To build a production version of the components, run:
98-
99-
```bash
100-
gulp
101-
```
102-
103-
This will clean the `dist` folder and rebuild the assets for serving.
104-
105-
### Templates
106-
107-
The `templates/` subdirectory contains a few exemplary usages of MDL. Templates
108-
have their own, quasi-separate gulp pipeline and can be compiled with
109-
`gulp templates`. The templates use the vanilla MDL JS and
110-
[themed](http://www.getmdl.io/customize/index.html) CSS files. Extraneous styles
111-
are kept in a separate CSS file. Use `gulp serve` to take a look at the
112-
templates:
113-
114-
* [Blog Template](http://www.getmdl.io/templates/blog)
115-
* [Dashboard Template](http://www.getmdl.io/templates/dashboard)
116-
* [Text Heavy Webpage Template](http://www.getmdl.io/templates/text-only)
117-
* [Stand Alone Article Template](http://www.getmdl.io/templates/article)
118-
* [Android.com MDL Skin Template](http://www.getmdl.io/templates/android-dot-com)
119-
* [Portfolio Template](http://www.getmdl.io/templates/portfolio)
120-
121-
> Templates are not officially supported in IE9 and legacy browsers that do not
122-
pass the minimum-requirements defined in our
123-
[cutting-the-mustard test](https://github.com/google/material-design-lite/blob/87c48c22416c3e83850f7711365b2a43ba19c5ce/src/mdlComponentHandler.js#L336-L349).
124-
125-
The templates refer to CDN hosted versions of the libraries. If you'd like to
126-
test the templates against locally built MDL libraries you need to run the
127-
`templates:localtestingoverride` gulp task before running `gulp serve`:
128-
129-
```bash
130-
gulp all && gulp templates:localtestingoverride && gulp serve
131-
```
132-
133-
> Beware as any changes to the `templates` directory will automatically revert
134-
the templates local testing overrides. In this case make sure you run the
135-
`templates:localtestingoverride` gulp task again or modify the `watch()`
136-
function in the gulp file.
137-
138-
## Versioning
139-
140-
For transparency into our release cycle and in striving to maintain backward
141-
compatibility, Material Design Lite is maintained under
142-
[the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up,
143-
but we'll adhere to those rules whenever possible.
144-
14585
## Feature requests
14686

14787
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
15191
Design specs and therefore some requests might not be within the scope of this
15292
project.
15393

154-
## Want to contribute?
155-
156-
If you found a bug, have any questions or want to contribute. Follow our
157-
[guidelines](https://github.com/google/material-design-lite/blob/master/CONTRIBUTING.md),
158-
and help improve the Material Design Lite. For more information visit our
159-
[wiki](https://github.com/google/material-design-lite/wiki).
160-
161-
## Do you include any features that a framework comes with?
162-
163-
Material Design Lite is focused on delivering a vanilla CSS/JS/HTML library of
164-
components. We are not a framework. If you are building a single-page app and
165-
require features like two-way data-binding, templating, CSS scoping and so
166-
forth, we recommend trying out the excellent
167-
[Polymer](http://polymer-project.org) project.
168-
16994
## License
17095

17196
© Google, 2015. Licensed under an

0 commit comments

Comments
 (0)