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