dotfiles/.atom/packages/atom-material-ui/README.md

75 lines
2.6 KiB
Markdown

[![Build Status](https://img.shields.io/travis/atom-material/atom-material-ui.svg?style=flat-square)](https://travis-ci.org/atom-material/atom-material-ui)
[![apm](https://img.shields.io/apm/dm/atom-material-ui.svg?style=flat-square)](https://atom.io/packages/atom-material-ui)
[![apm](https://img.shields.io/apm/v/atom-material-ui.svg?style=flat-square)](https://atom.io/packages/atom-material-ui)
[![apm](https://img.shields.io/apm/l/atom-material-ui.svg?style=flat-square)]()
[![Gitter](https://img.shields.io/gitter/room/silvestreh/atom-material-ui.svg?style=flat-square)](https://gitter.im/silvestreh/atom-material-ui)
[![Support AMU](https://img.shields.io/badge/donate-on%20pledgie-green.svg?style=flat-square)](https://pledgie.com/campaigns/29552)
![AMU](http://i.imgur.com/7C2H2mw.png)
---
A dynamic UI theme for Atom that (kinda) follows Google's Material Design Guidelines. Best with [Atom Material Syntax](https://github.com/atom-material/atom-material-syntax).
Inspired by Mattia Astorino's [SublimeText theme](https://github.com/equinusocio/material-theme).
# Installation
Fire up a console and type:
```shell
apm install atom-material-ui
```
Or, inside Atom's settings select Install and then search for this package.
# Configuration
Atom Material UI supports different accent colors. To change it, go to Settings > Themes and click the cog icon next to the theme selector.
![](http://i.imgur.com/pf3oiZr.png)
You'll find the color picker there.
# Screenshots
Here's the obligatory screenshot.
### With [Atom Material Syntax](https://atom.io/packages/atom-material-syntax)
```shell
apm install atom-material-syntax
```
![](http://i.imgur.com/ExPYmJY.png)
### With [Light syntax](https://atom.io/packages/atom-material-syntax-light) theme variant
```shell
apm install atom-material-syntax-light
```
![](http://i.imgur.com/q1o78sX.png)
### With [Dark syntax](https://atom.io/packages/atom-material-syntax-dark) theme variant
```shell
apm install atom-material-syntax-dark
```
![](http://i.imgur.com/orhIvwS.png)
# Contributing
Please check the [CONTRIBUTING.md](https://github.com/atom-material/atom-material-ui/blob/master/CONTRIBUTING.md) file.
# Extra
![](http://i.imgur.com/0tHORB1.png)
You can download the redesigned icon from [dropbox](https://www.dropbox.com/s/8gyn40sw95626dx/Atom-MD-Icon.zip?dl=0). It's a ZIP file containing multiple resolution PNGs, ICNS and ICO formats. Windows ICO converted by Akshit Tripathi.
# License
Atom Material UI is licensed under MIT.
View the license file [here](https://github.com/atom-material/atom-material-ui/blob/master/LICENSE.md)