Skip to content

Commit

Permalink
Added instructions to build the doc site to readme. Closes #58
Browse files Browse the repository at this point in the history
  • Loading branch information
Hai Nguyen committed Nov 28, 2014
1 parent a0fe16e commit 4ba74f5
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,21 @@ This allows you to override any variables defined in [custom-variables.less](htt
@import "node_modules/material-ui/src/less/components.less";
```

## Building the Documentation Site
After cloning the repository, install dependencies:
```
cd <project folder>/material-ui
npm install
cd <project folder>/material-ui/docs
npm install
npm install -g gulp
```

Now you can run your local server:
```
gulp
```

## Contribute

[Material-UI](http://www.material-ui.com/) came about from our love of [React](http://facebook.github.io/react/) and [Google's Material Design](https://www.google.com/design/spec/material-design/introduction.html). We're currently using it on a project at [Call-Em-All](https://www.call-em-all.com/) and plan on adding to it and making it better. If you'd like to help, check out the [docs folder](https://github.com/callemall/material-ui/tree/master/docs). We'd greatly appreciate any contribution you make. :)

0 comments on commit 4ba74f5

Please sign in to comment.