|
1 |
| -<p align="center"> |
2 |
| - <a href="http://materializecss.com/"> |
3 |
| - <img src="http://materializecss.com/res/materialize.svg" width="150"> |
4 |
| - </a> |
5 |
| - |
6 |
| - <h3 align="center">MaterializeCSS</h3> |
7 |
| - |
8 |
| - <p align="center"> |
9 |
| - Materialize, a CSS Framework based on material design. |
10 |
| - <br> |
11 |
| - <a href="http://materializecss.com/"><strong>-- Browse the docs --</strong></a> |
12 |
| - <br> |
13 |
| - <br> |
14 |
| - <a href="https://travis-ci.org/Dogfalo/materialize"> |
15 |
| - <img src="https://travis-ci.org/Dogfalo/materialize.svg?branch=master" alt="Travis CI badge"> |
16 |
| - </a> |
17 |
| - <a href="https://badge.fury.io/js/materialize-css"> |
18 |
| - <img src="https://badge.fury.io/js/materialize-css.svg" alt="npm version badge"> |
19 |
| - </a> |
20 |
| - <a href="https://cdnjs.com/libraries/materialize"> |
21 |
| - <img src="https://img.shields.io/cdnjs/v/materialize.svg" alt="CDNJS version badge"> |
22 |
| - </a> |
23 |
| - <a href="https://david-dm.org/Dogfalo/materialize"> |
24 |
| - <img src="https://david-dm.org/Dogfalo/materialize/status.svg" alt="dependencies Status badge"> |
25 |
| - </a> |
26 |
| - <a href="https://david-dm.org/Dogfalo/materialize#info=devDependencies"> |
27 |
| - <img src="https://david-dm.org/Dogfalo/materialize/dev-status.svg" alt="devDependency Status badge"> |
28 |
| - </a> |
29 |
| - <a href="https://gitter.im/Dogfalo/materialize"> |
30 |
| - <img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"> |
31 |
| - </a> |
32 |
| -</p> |
33 |
| - |
34 |
| -## Table of Contents |
35 |
| -- [Quickstart](#quickstart) |
36 |
| -- [Documentation](#documentation) |
37 |
| -- [Supported Browsers](#supported-browsers) |
38 |
| -- [Changelog](#changelog) |
39 |
| -- [Testing](#testing) |
40 |
| -- [Contributing](#contributing) |
41 |
| -- [Copyright and license](#copyright-and-license) |
42 |
| - |
43 |
| -## Quickstart: |
44 |
| -Read the [getting started guide](http://materializecss.com/getting-started.html) for more information on how to use materialize. |
45 |
| - |
46 |
| -- [Download the latest release](https://github.com/Dogfalo/materialize/releases/latest) of materialize directly from GitHub. |
47 |
| -- Clone the repo: `git clone https://github.com/Dogfalo/materialize.git` |
48 |
| -- Include the files via [cdnjs](https://cdnjs.com/libraries/materialize). More [here](http://materializecss.com/getting-started.html). |
49 |
| -- Install with [npm](https://www.npmjs.com): `npm install materialize-css` |
50 |
| -- Install with [Bower](https://bower.io): `bower install materialize` |
51 |
| -- Install with [Atmosphere](https://atmospherejs.com): `meteor add materialize:materialize` |
52 |
| - |
53 |
| -## Documentation |
54 |
| -The documentation can be found at <http://materializecss.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. |
55 |
| - |
56 |
| -### Running documentation locally |
57 |
| -Run these commands to set up the documentation: |
58 |
| - |
59 |
| -```bash |
60 |
| -git clone https://github.com/Dogfalo/materialize |
61 |
| -cd materialize |
62 |
| -npm install |
63 |
| -``` |
64 |
| - |
65 |
| -Then run `grunt monitor` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation. |
66 |
| - |
67 |
| -### Documentation for previous releases |
68 |
| -Previous releases and their documentation are available for [download](https://github.com/Dogfalo/materialize/releases). |
69 |
| - |
70 |
| -## Supported Browsers: |
71 |
| -Materialize is compatible with: |
72 |
| - |
73 |
| -- Chrome 35+ |
74 |
| -- Firefox 31+ |
75 |
| -- Safari 7+ |
76 |
| -- Opera |
77 |
| -- Edge |
78 |
| -- IE 10+ |
79 |
| - |
80 |
| -## Changelog |
81 |
| -For changelogs, check out [the Releases section of materialize](https://github.com/Dogfalo/materialize/releases) or the [CHANGELOG.md](CHANGELOG.md). |
82 |
| - |
83 |
| -## Testing |
84 |
| -We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help, [here's a starting guide on how to write tests in Jasmine](CONTRIBUTING.md#jasmine-testing-guide). |
85 |
| - |
86 |
| -## Contributing |
87 |
| -Check out the [CONTRIBUTING document](CONTRIBUTING.md) in the root of the repository to learn how you can contribute. You can also browse the [help-wanted](https://github.com/Dogfalo/materialize/labels/help-wanted) tag in our issue tracker to find things to do. |
88 |
| - |
89 |
| -## Copyright and license |
90 |
| -Code copyright 2017 Materialize. Code released under the MIT license. |
| 1 | +<p align="center"> |
| 2 | + <a href="http://materializecss.com/"> |
| 3 | + <img src="http://materializecss.com/res/materialize.svg" width="150"> |
| 4 | + </a> |
| 5 | + |
| 6 | + <h3 align="center">MaterializeCSS</h3> |
| 7 | + |
| 8 | + <p align="center"> |
| 9 | + Materialize, a CSS Framework based on material design. |
| 10 | + <br> |
| 11 | + <a href="http://materializecss.com/"><strong>-- Browse the docs --</strong></a> |
| 12 | + <br> |
| 13 | + <br> |
| 14 | + <a href="https://travis-ci.org/Dogfalo/materialize"> |
| 15 | + <img src="https://travis-ci.org/Dogfalo/materialize.svg?branch=master" alt="Travis CI badge"> |
| 16 | + </a> |
| 17 | + <a href="https://badge.fury.io/js/materialize-css"> |
| 18 | + <img src="https://badge.fury.io/js/materialize-css.svg" alt="npm version badge"> |
| 19 | + </a> |
| 20 | + <a href="https://cdnjs.com/libraries/materialize"> |
| 21 | + <img src="https://img.shields.io/cdnjs/v/materialize.svg" alt="CDNJS version badge"> |
| 22 | + </a> |
| 23 | + <a href="https://david-dm.org/Dogfalo/materialize"> |
| 24 | + <img src="https://david-dm.org/Dogfalo/materialize/status.svg" alt="dependencies Status badge"> |
| 25 | + </a> |
| 26 | + <a href="https://david-dm.org/Dogfalo/materialize#info=devDependencies"> |
| 27 | + <img src="https://david-dm.org/Dogfalo/materialize/dev-status.svg" alt="devDependency Status badge"> |
| 28 | + </a> |
| 29 | + <a href="https://gitter.im/Dogfalo/materialize"> |
| 30 | + <img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"> |
| 31 | + </a> |
| 32 | +</p> |
| 33 | + |
| 34 | +## Table of Contents |
| 35 | +- [Quickstart](#quickstart) |
| 36 | +- [Documentation](#documentation) |
| 37 | +- [Supported Browsers](#supported-browsers) |
| 38 | +- [Changelog](#changelog) |
| 39 | +- [Testing](#testing) |
| 40 | +- [Contributing](#contributing) |
| 41 | +- [Copyright and license](#copyright-and-license) |
| 42 | + |
| 43 | +## Quickstart: |
| 44 | +Read the [getting started guide](http://materializecss.com/getting-started.html) for more information on how to use materialize. |
| 45 | + |
| 46 | +- [Download the latest release](https://github.com/Dogfalo/materialize/releases/latest) of materialize directly from GitHub. |
| 47 | +- Clone the repo: `git clone https://github.com/Dogfalo/materialize.git` |
| 48 | +- Include the files via [cdnjs](https://cdnjs.com/libraries/materialize). More [here](http://materializecss.com/getting-started.html). |
| 49 | +- Install with [npm](https://www.npmjs.com): `npm install materialize-css` |
| 50 | +- Install with [Bower](https://bower.io): `bower install materialize` ([DEPRECATED](https://bower.io/blog/2017/how-to-migrate-away-from-bower/)) |
| 51 | +- Install with [Atmosphere](https://atmospherejs.com): `meteor add materialize:materialize` |
| 52 | + |
| 53 | +## Documentation |
| 54 | +The documentation can be found at <http://materializecss.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. |
| 55 | + |
| 56 | +### Running documentation locally |
| 57 | +Run these commands to set up the documentation: |
| 58 | + |
| 59 | +```bash |
| 60 | +git clone https://github.com/Dogfalo/materialize |
| 61 | +cd materialize |
| 62 | +npm install |
| 63 | +``` |
| 64 | + |
| 65 | +Then run `grunt monitor` to compile the documentation. When it finishes, open a new browser window and navigate to `localhost:8000`. We use [BrowserSync](https://www.browsersync.io/) to display the documentation. |
| 66 | + |
| 67 | +### Documentation for previous releases |
| 68 | +Previous releases and their documentation are available for [download](https://github.com/Dogfalo/materialize/releases). |
| 69 | + |
| 70 | +## Supported Browsers: |
| 71 | +Materialize is compatible with: |
| 72 | + |
| 73 | +- Chrome 35+ |
| 74 | +- Firefox 31+ |
| 75 | +- Safari 9+ |
| 76 | +- Opera |
| 77 | +- Edge |
| 78 | +- IE 11+ |
| 79 | + |
| 80 | +## Changelog |
| 81 | +For changelogs, check out [the Releases section of materialize](https://github.com/Dogfalo/materialize/releases) or the [CHANGELOG.md](CHANGELOG.md). |
| 82 | + |
| 83 | +## Testing |
| 84 | +We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help, [here's a starting guide on how to write tests in Jasmine](CONTRIBUTING.md#jasmine-testing-guide). |
| 85 | + |
| 86 | +## Contributing |
| 87 | +Check out the [CONTRIBUTING document](CONTRIBUTING.md) in the root of the repository to learn how you can contribute. You can also browse the [help-wanted](https://github.com/Dogfalo/materialize/labels/help-wanted) tag in our issue tracker to find things to do. |
| 88 | + |
| 89 | +## Copyright and license |
| 90 | +Code copyright 2017 Materialize. Code released under the MIT license. |
0 commit comments