Skip to content
This repository has been archived by the owner on Nov 21, 2023. It is now read-only.

Commit

Permalink
Updated readme in dev section and removed unused jshint-stylish (#164)
Browse files Browse the repository at this point in the history
* updated development section of readme

* removed unnecessary jshint-stylish dependency
  • Loading branch information
marcofugaro authored and terrymun committed May 24, 2016
1 parent 9a0f75b commit 47db04b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 20 deletions.
19 changes: 2 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ The full list of Fluidbox configurations:

## Developer notes
### Building with Grunt
Fluidbox is built using [Grunt](http://gruntjs.com) and [NodeJS](https://nodejs.org/). If you are new to this, kindly refer to [Matt Bailey's excellent guide on setting up Grunt](http://mattbailey.io/a-beginners-guide-to-grunt-redux/). To build Fluidbox, you will need to install the following dependencies:
Fluidbox is built using [Grunt](http://gruntjs.com) and [NodeJS](https://nodejs.org/). If you are new to this, kindly refer to [Matt Bailey's excellent guide on setting up Grunt](http://mattbailey.io/a-beginners-guide-to-grunt-redux/). To build Fluidbox, you will need to run `npm install` and install the following dependencies:

| Grunt dependency | Comment |
|------------------|---------|
Expand All @@ -307,22 +307,7 @@ Fluidbox is built using [Grunt](http://gruntjs.com) and [NodeJS](https://nodejs.
| [grunt-contrib-watch](https://www.npmjs.com/package/grunt-contrib-watch) | Allows you to build on the fly using `$ grunt watch` by watching for file changes, so that you don't have to run `$ grunt` at the project root all the time manually. |
| [grunt-postcss](https://www.npmjs.com/package/grunt-postcss) | Uses PostCSS to dynamically add prefixes and handle minification thereafter. |

Quick and dirty: here's how to install the Grunt dependencies listed above:
```shell
$ npm install grunt --save-dev
$ npm install time-grunt --save
$ npm install load-grunt-config --save-dev
$ npm install grunt-concurrent --save-dev
$ npm install grunt-contrib-clean --save-dev
$ npm install grunt-sass --save-dev
$ npm install grunt-contrib-uglify --save-dev
$ npm install grunt-contrib-jshint --save-dev
$ npm install jshint-stylish --save
$ npm install grunt-contrib-watch --save-dev
$ npm install grunt-postcss --save-dev
$ npm install grunt-postcss autoprefixer cssnano
```
The main tasks are `grunt` or `grunt prod`, which minifies everything and makes it ready for produciton, and `grunt dev` which instead creates a build for testing and development.

#### Configuration
The configuration for each Grunt task can be found in their respecitve `.js` files in the `/grunt` folder.
Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@
],
"license": "MIT",
"dependencies": {
"jquery": ">=1.9",
"jshint-stylish": "^2.1.0"
"jquery": ">=1.9"
},
"npmName": "fluidbox",
"npmFileMap": [
Expand All @@ -48,7 +47,7 @@
"grunt-contrib-watch": "^0.6.1",
"grunt-postcss": "^0.7.1",
"grunt-sass": "^1.1.0",
"jshint-stylish": "^2.0.1",
"jshint-stylish": "^2.1.0",
"load-grunt-config": "^0.17.2",
"time-grunt": "^1.2.1"
},
Expand Down

0 comments on commit 47db04b

Please sign in to comment.