From ec996d80b495ed8ca037a5140c0334a83df82e36 Mon Sep 17 00:00:00 2001 From: grosbouddha Date: Mon, 27 May 2013 23:57:39 +0200 Subject: [PATCH] Adding notes to run Grunt tasks --- Gruntfile.js | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Gruntfile.js b/Gruntfile.js index b085f9b..15a6ad5 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -1,3 +1,15 @@ +/** + * How to run grunt tasks: + * - At project root, run 'npm install' - It will install nodedependencies declared in package,json in /.node_modules + * - install grunt CLI tools globally, run 'npm install -g grunt-cli' + * - run a grunt target defined in Gruntfiles.js, ex: 'grunt lint' + * + * Note: The 'ghost' grunt task have special deps on CasperJS and phantomjs. + * For now, It's configured to run only on TravisCI where these deps are + * correctly defined. + * If you run this task locally, it may require some env set up first. + */ + module.exports = function(grunt) { grunt.initConfig({ jshint: { @@ -45,5 +57,4 @@ module.exports = function(grunt) { grunt.registerTask('lint', ['jshint']); grunt.registerTask('test', ['jshint', 'connect', 'ghost']); - };