Skip to content

Commit 2e62a8b

Browse files
author
Fez Vrasta
committed
Merge pull request mdbootstrap#95 from nelsonomuto/master
Updating Readme docs with developer section and build status icon
2 parents 5c0b558 + 4c845b1 commit 2e62a8b

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![build status](https://travis-ci.org/FezVrasta/bootstrap-material-design.svg?branch=master)](https://travis-ci.org/FezVrasta/bootstrap-material-design)
2+
13
[![banner](demo/imgs/banner.jpg)](#)
24

35
This Bootstrap theme is an easy way to use the new [Material Design guidelines by Google](http://www.google.com/design/spec/material-design/introduction.html) in your Bootstrap 3 based application.
@@ -25,6 +27,17 @@ so this might not be true before the first stable release.
2527
Navigate to the `template/` folder in this repository, and you will see the `index.html` file, which has the CSS include statements, in the `head` section and the JS includes just before `body` section closes.
2628
You need to copy the `material/` folder to the root of your project, ensuring that all the files in your project can access the files through the relative URL, supplied in the CSS and the JS includes.
2729

30+
## Development
31+
32+
We are using grunt to automate the workflow and build process. Ensure you have nodejs installed and grunt-cli installed globally.
33+
After cloning the repo, run `npm install` to ensure you have all dev dependencies.
34+
35+
Run the `grunt build` command to run the tests and compile the less/sass. See Gruntfile.js for details on targets.
36+
37+
Run the `grunt test` command for browser based jasmine unit tests.
38+
39+
Run the `grunt serve` command to build and fire up a http server with live-reload and a watch for development purposes.
40+
2841
## Todo
2942

3043
- Morphing icons

0 commit comments

Comments
 (0)