Documentation update

meltingice · Jun 22, 2013 · 1f6d999 · 1f6d999
1 parent b2e1baf
commit 1f6d999
Show file tree

Hide file tree

Showing 35 changed files with 36 additions and 48 deletions.
diff --git a/api/LICENSE.html b/api/LICENSE.html
@@ -129,7 +129,7 @@
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/README.md.html b/api/README.md.html
@@ -129,24 +129,12 @@ <h3>HiDPI Support</h3><p>Version 4 introduces better support for HiDPI (Retina)
 <h2>Upgrading to Version 4</h2><p>There is only 1 breaking change that occured with the version 4 release. When you initialize CamanJS with a canvas and an image, the parameter order has changed. It is now:</p><pre><code class="lang-javascript">Caman(&quot;#canvas-id&quot;, &quot;/path/to/image.png&quot;, function() {});</code></pre><p>This is in order to be more consistent with initialization, such that the &quot;initialization object&quot; is always the first parameter. Update your code accordingly.</p><h2>Development</h2><p>If you are a developer who is contributing directly to the project, there are some tools to help you out.</p><h3>Building</h3><p>To install all dependencies required for development, run <code>npm install -d</code>.</p><p>Because all plugins are in a separate repository, make sure you run:</p><pre><code>git submodule init &amp;&amp; git submodule update</code></pre><p>To build, simply run <code>cake build</code>. The resulting files will be placed in the dist/ folder. Plugins will be automatically discovered and added to caman.full.js after the core library. You can also auto-compile when a file changes by using <code>cake watch</code>.</p><p>If you add any files to the core library, you will need to add them to the <code>coffeeFiles</code> array in the Cakefile. The point of this is so that order is preserved when generating the file JS file. Plugins do not need to be added to the Cakefile.</p><p>You will probably want to generate documentation if you make any changes. In addition to the normal requirements, you will also need the Python library Pygments.</p><p>To generate the documentation, run <code>cake docs</code>.</p><h2>CDN JS Hosting</h2><p>CamanJS is hosted on CDN JS if you&#39;re looking for a CDN hosting solution. It is the full and minified version of the library, which means all plugins are included. Simply load CamanJS directly from <a href="http://cdnjs.cloudflare.com/ajax/libs/camanjs/3.3.0/caman.full.min.js">this URL</a> for usage on your site.</p><h2>NodeJS Compatibility</h2><p>CamanJS is fully compatible with NodeJS. The easiest way to install it is:</p><pre><code>npm install caman</code></pre><p><strong>Saving from NodeJS</strong></p><p>To save your modified image in NodeJS, simply call the save() function <strong>after</strong> rendering is finished by passing a callback function to <code>render()</code>. Trying to save before rendering is finished will cause issues.</p><pre><code class="lang-coffeescript">Caman &quot;./path/to/file.jpg&quot;, -&gt;
   @brightness 40
   @render -&gt; @save &quot;./output.jpg&quot;</code></pre>
-<h2>Testing</h2><p>Tests for CamanJS run both in NodeJS and the browser.</p><h3>NodeJS</h3><p>The NodeJS tests use mocha as the test runner. The simplest way to run the test suite is by running <code>npm test</code>.</p><h3>Browser</h3><p>The browser tests are run by Karma. It will start up Chrome, Firefox, and Safari (if running OSX) in the background. You can minimize each of these browsers if desired. It will automatically run tests after CamanJS is recompiled by the Cakefile as well.</p><p>You can run Karma by running <code>karma start</code>, or you can do a single run with the NodeJS tests by running <code>npm test</code>.</p><h2>Project Contributors</h2>
-<ul>
-<li><a href="http://twitter.com/meltingice">Ryan LeFevre</a> - Project Creator, Maintainer, and Lead Developer</li>
-<li><a href="http://twitter.com/rwaldron">Rick Waldron</a> - Plugin Architect and Developer</li>
-<li><a href="http://twitter.com/cezarsa">Cezar Sá Espinola</a> - Developer</li>
-<li><a href="http://twitter.com/jarques">Jarques Pretorius</a> - Logo Designer</li>
-</ul>
-<h2>Plugin Contributors</h2>
-<ul>
-<li><a href="https://github.com/Hosselaer">Hosselaer</a></li>
-<li><a href="http://www.quasimondo.com">Mario Klingemann</a></li>
-</ul>
-
+<h2>Testing</h2><p>Tests for CamanJS run both in NodeJS and the browser.</p><h3>NodeJS</h3><p>The NodeJS tests use mocha as the test runner. The simplest way to run the test suite is by running <code>npm test</code>.</p><h3>Browser</h3><p>The browser tests are run by Karma. It will start up Chrome, Firefox, and Safari (if running OSX) in the background. You can minimize each of these browsers if desired. It will automatically run tests after CamanJS is recompiled by the Cakefile as well.</p><p>You can run Karma by running <code>karma start</code>, or you can do a single run with the NodeJS tests by running <code>npm test</code>.</p>
       </div>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/class_index.html b/api/class_index.html
@@ -416,7 +416,7 @@ <h2>File Listing A-Z</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman.html b/api/classes/Caman.html
@@ -1446,7 +1446,7 @@ <h3>Parameters:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Analyze.html b/api/classes/Caman/Analyze.html
@@ -181,7 +181,7 @@ <h3>Returns:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Blender.html b/api/classes/Caman/Blender.html
@@ -220,7 +220,7 @@ <h3>Returns:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Calculate.html b/api/classes/Caman/Calculate.html
@@ -371,7 +371,7 @@ <h3>Returns:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Convert.html b/api/classes/Caman/Convert.html
@@ -986,7 +986,7 @@ <h3>See also:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Event.html b/api/classes/Caman/Event.html
@@ -272,7 +272,7 @@ <h3>Parameters:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Filter.html b/api/classes/Caman/Filter.html
@@ -170,7 +170,7 @@ <h3>Parameters:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/IO.html b/api/classes/Caman/IO.html
@@ -471,7 +471,7 @@ <h3>See also:</h3>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Layer.html b/api/classes/Caman/Layer.html
@@ -302,7 +302,7 @@ <h2>Instance Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Logger.html b/api/classes/Caman/Logger.html
@@ -149,7 +149,7 @@ <h2>Constructor Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Pixel.html b/api/classes/Caman/Pixel.html
@@ -363,7 +363,7 @@ <h2>Instance Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Plugin.html b/api/classes/Caman/Plugin.html
@@ -165,7 +165,7 @@ <h2>Class Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Renderer.html b/api/classes/Caman/Renderer.html
@@ -369,7 +369,7 @@ <h2>Instance Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Caman/Store.html b/api/classes/Caman/Store.html
@@ -217,7 +217,7 @@ <h2>Class Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/CamanParser.html b/api/classes/CamanParser.html
@@ -227,7 +227,7 @@ <h2>Instance Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Module.html b/api/classes/Module.html
@@ -249,7 +249,7 @@ <h2>Class Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/classes/Util.html b/api/classes/Util.html
@@ -201,7 +201,7 @@ <h2>Class Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/analyze.coffee.html b/api/files/core/analyze.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/autoload.coffee.html b/api/files/core/autoload.coffee.html
@@ -146,7 +146,7 @@ <h2>Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/blender.coffee.html b/api/files/core/blender.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/calculate.coffee.html b/api/files/core/calculate.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/caman.coffee.html b/api/files/core/caman.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/convert.coffee.html b/api/files/core/convert.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/event.coffee.html b/api/files/core/event.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/filter.coffee.html b/api/files/core/filter.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/io.coffee.html b/api/files/core/io.coffee.html
@@ -131,7 +131,7 @@ <h2>Constant Summary</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/layer.coffee.html b/api/files/core/layer.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/pixel.coffee.html b/api/files/core/pixel.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/plugin.coffee.html b/api/files/core/plugin.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/renderer.coffee.html b/api/files/core/renderer.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/store.coffee.html b/api/files/core/store.coffee.html
@@ -119,7 +119,7 @@ <h1>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0

diff --git a/api/files/core/util.coffee.html b/api/files/core/util.coffee.html
@@ -146,7 +146,7 @@ <h2>Method Details</h2>
     </div>
     <div id='footer'>
   Generated on
-  Fri Jun 21 2013 22:38:25 GMT-0400 (EDT)
+  Fri Jun 21 2013 23:13:05 GMT-0400 (EDT)
   by
   <a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
   v1.7.0