You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2014/01/20 19:42:09 UTC
[19/32] git commit: Added in README changes to help understanding
with Grunt and LESS changes. Added grunt fix for watch
Added in README changes to help understanding with Grunt and LESS changes. Added grunt fix for watch
Project: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/commit/92690354
Tree: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/tree/92690354
Diff: http://git-wip-us.apache.org/repos/asf/cordova-registry-web/diff/92690354
Branch: refs/heads/refactor
Commit: 92690354f7e07d53f64ec2e7591199128cacb05d
Parents: b75f846
Author: Josh Bavari <jo...@raisemore.com>
Authored: Sun Jan 19 01:05:59 2014 -0600
Committer: Josh Bavari <jo...@raisemore.com>
Committed: Sun Jan 19 01:05:59 2014 -0600
----------------------------------------------------------------------
Gruntfile.js | 2 +-
README.md | 23 ++++++++++++++++++++++-
2 files changed, 23 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-registry-web/blob/92690354/Gruntfile.js
----------------------------------------------------------------------
diff --git a/Gruntfile.js b/Gruntfile.js
index 001f33f..336ecda 100644
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -11,7 +11,7 @@ module.exports = function(grunt) {
},
watch: {
changeFiles: {
- files: ['attachments/*.html', 'attachments/partials/**/*.html', 'attachments/css/*.less', 'attachments/css/**/*.css', 'attachments/js/**/*.js'],
+ files: ['attachments/*.html', 'attachments/partials/**/*.html', 'attachments/css/**/*.less', 'attachments/css/**/*.css', 'attachments/js/**/*.js'],
tasks: ['less', 'shell:reloadServer']
},
options: {
http://git-wip-us.apache.org/repos/asf/cordova-registry-web/blob/92690354/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index a6fe16b..5f09a58 100644
--- a/README.md
+++ b/README.md
@@ -78,4 +78,25 @@ Alternative\
couchapp serve app.js http://localhost:5984/registry -p 3000 -l -d attachments/\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural
\cf0 \
-}
\ No newline at end of file
+}
+
+## Changes to LESS
+
+The project is now heavily using LESS using imports
+
+To get started, take a peak into styles.less - this contains @import statements to pull in other stylesheets to help organize the styles. Compile it with your favorite less compiler or use `grunt less` if you'd wish.
+
+## Using Grunt
+
+Grunt has been added to help with some mundane tasks.
+
+To get started, `npm install` this should install Grunt and its plugins.
+
+You can run a few commands with grunt.
+
+* View Grunt tasks available `grunt --help`
+* JSHint the javascript files `grunt jshint`
+* Compile the LESS `grunt less`
+* Watch all HTML/JS/CSS/LESS files - and if changes are made, auto compile LESS and reload the server with latest code `grunt watch`
+
+NOTE - The Grunt watch command is set up to use livereload - this will automatically reload your browser after the server is done reloading - no more needing to click the refresh button on your browser. The livereload script is put in the HEAD of the index.html page - if you wish to not use it, you will need to comment or remove that from the index.html page.
\ No newline at end of file