fixed gulp and changed banner content

also changed README.md
minizenobia · Nov 19, 2014 · d246c91 · d246c91
1 parent ae514bd
commit d246c91
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -37,22 +37,21 @@ The major perks of using ScrollMagic include:
 ScrollMagic takes an object oriented approach using a controller for each scroll container and multiple "scroll scenes" to define what should happen at what point in time. While this offers a great deal of control it might be a little confusing, especially if you're just starting out with javascript.  
 If the above points are not crucial for you and you are just looking for a simple solution to implement basic css animations I would strongly recommend taking a look at the awesome [skrollr](http://prinzhorn.github.io/skrollr/) project. It almost solely relys on element attributes and thus requires minimal to no javascript knowledge.
 
-## Installation
-Aside from [jQuery](http://jquery.com/) make sure you have loaded the [Greensock Animation Plattform (TweenMax)](http://www.greensock.com/gsap-js/).  
-To use ScrollMagic in your project simply include the plugin js file in the head section of your HTML file:
+## Installation  
+To use ScrollMagic in your project simply copy the scrollmagic folder into your project's javascript folder and include it in the head section of your HTML file:
 ```html
-<script type="text/javascript" src="scrollmagic/uncompressed/ScrollMagic.js"></script>
+<script src="js/scrollmagic/uncompressed/ScrollMagic.js"></script>
 ```
 
 For deployment use the minified version __instead__:
 ```html
-<script type="text/javascript" src="scrollmagic/minified/ScrollMagic.min.js"></script>
+<script src="js/scrollmagic/minified/ScrollMagic.min.js"></script>
 ```
 _**NOTE:** The logging feature is removed in the minified version for obvious file size considerations._
 
 To have access to the debugging extension during development, include this file __additionally__:
 ```html
-<script type="text/javascript" src="scrollmagic/uncompressed/plugins/SceneIndicators.js"></script>
+<script src="js/scrollmagic/uncompressed/plugins/SceneIndicators.js"></script>
 ```
 You can remove the debugging extension for actual deployment.
 

diff --git a/dev/src/banner.regular.js b/dev/src/banner.regular.js
@@ -1,12 +1,10 @@
-/*
+/**
 ScrollMagic v%VERSION% (%YEAR%-%MONTH%-%DAY%)
 %DESCRIPTION%
 (c) %YEAR% Jan Paepke (@janpaepke)
-License & Info: http://janpaepke.github.io/ScrollMagic
-	
-Inspired by and partially based on SUPERSCROLLORAMA by John Polacek (@johnpolacek)
-http://johnpolacek.github.com/superscrollorama/
+Project Website: http://janpaepke.github.io/ScrollMagic
 
-Powered by the Greensock Tweening Platform (GSAP): http://www.greensock.com/js
-Greensock License info at http://www.greensock.com/licensing/
+@version	%VERSION%
+@license	Dual licensed under MIT license and GPL.
+@author		Jan Paepke - [email protected]
 */
diff --git a/dev/src/core.js b/dev/src/core.js
@@ -1,9 +1,5 @@
-/**
-@overview	##Info
-@version	%VERSION%
-@license	Dual licensed under MIT license and GPL.
-@author		Jan Paepke - [email protected]
-
+/*
+@todo: remove todos on build
 @todo: enhancement: remove dependencies and move to plugins -> 2.0
 @todo: bug: when cascading pins (pinning one element multiple times) and later removing them without reset, positioning errors occur.
 @todo: bug: having multiple scroll directions with cascaded pins doesn't work (one scroll vertical, one horizontal)

diff --git a/dev/src/plugins/SceneIndicators.js b/dev/src/plugins/SceneIndicators.js
@@ -1,8 +1,5 @@
 /*
-	@overview Debug Extension for ScrollMagic.
-	@version	%VERSION%
-	@license	Dual licensed under MIT license and GPL.
-	@author		Jan Paepke - [email protected]
+	Debug Extension for ScrollMagic.
 */
 (function (root, factory) {
     if (typeof define === 'function' && define.amd) {

diff --git a/dev/src/plugins/animation.gsap.js b/dev/src/plugins/animation.gsap.js
@@ -1,8 +1,8 @@
 /*
-	@overview ScrollMagic Animation Extension for GSAP.
-	@version	%VERSION%
-	@license	Dual licensed under MIT license and GPL.
-	@author		Jan Paepke - [email protected]
+	ScrollMagic GSAP Animation Plugin.
+
+    Powered by the Greensock Tweening Platform (GSAP): http://www.greensock.com/js
+    Greensock License info at http://www.greensock.com/licensing/
 */
 (function (root, factory) {
     if (typeof define === 'function' && define.amd) {

diff --git a/gulpfile.js b/gulpfile.js
@@ -58,7 +58,7 @@ var args = require('yargs')
 
 var options = {
 	version: args.ver,
-	dodocs: args.doc === './' + config.dirs.defaultOutput,
+	dodocs: !!args.doc,
 	folderOut: args.out,
 	folderDocsOut: args.doc.split ? args.doc : './' + config.dirs.defaultDocsOutput,
 	now: config.version === args.ver ? new Date(config.lastupdate) : new Date()
@@ -232,7 +232,7 @@ gulp.task('updatejsonfiles', ['validateoptions'], function() {
 					keep_array_indentation: true
 				}
 			))
-			.pipe(gulp.dest("./dev"));
+			.pipe(gulp.dest("./dev/build"));
 });
 
 gulp.task('updatereadme', ['validateoptions'], function() {