diff options
Diffstat (limited to 'app/dispatch/static/materialize/README.md')
| -rw-r--r-- | app/dispatch/static/materialize/README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/app/dispatch/static/materialize/README.md b/app/dispatch/static/materialize/README.md new file mode 100644 index 0000000..4dc0d04 --- /dev/null +++ b/app/dispatch/static/materialize/README.md @@ -0,0 +1,43 @@ + +=========== + +[](https://travis-ci.org/Dogfalo/materialize) +[](https://badge.fury.io/js/materialize-css) +[](https://david-dm.org/Dogfalo/materialize) +[](https://david-dm.org/Dogfalo/materialize#info=devDependencies) +[](https://gitter.im/Dogfalo/materialize?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +[Materialize](http://materializecss.com/), a CSS Framework based on material design + +### Current Version : v0.99.0 + +## Sass Requirements: +- Ruby Sass 3.3+, LibSass 0.6+ + +## Supported Browsers: +Chrome 35+, Firefox 31+, Safari 7+, IE 10+ + +## Quickstart: +Read the [Getting started page](http://materializecss.com/getting-started.html) for more information about the framework, templates and how to use materialize can be found on the [materializecss website](http://materializecss.com) + +- [Download the latest release](https://github.com/Dogfalo/materialize/releases/latest) directly from GitHub +- Clone the repo: `git clone https://github.com/Dogfalo/materialize.git` +- Include the files via [cdnjs](https://cdnjs.com/libraries/materialize). More [here](http://materializecss.com/getting-started.html) +- Install with [npm](https://www.npmjs.com): `npm install materialize-css` +- Install with [Bower](https://bower.io): `bower install materialize` + +## Compiling Files +- `npm install` +- `grunt monitor`, this will compile .scss, .js., .jade files. + +## Changelog +For changelogs, check out [the Releases section of materialize](https://github.com/Dogfalo/materialize/releases) or the [CHANGELOG.md](CHANGELOG.md) + +## Testing +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](https://docs.google.com/document/d/1dVM6qGt_b_y9RRhr9X7oZfFydaJIEqB9CT7yekv-4XE/edit?usp=sharing) + +## Contributing +[Please read CONTRIBUTING.md for more information](CONTRIBUTING.md) + +## Translation +If you want to help us translate the documentation into other languages, please send us an email at materializeframework@gmail.com telling us which language team you want to join. We use [Transifex](https://www.transifex.com) as our localization platform and we will send you an invite there. |