konva/README.md

#Building the KineticJS Framework 
To build the framework, you need to have node installed. After that, run `npm install` in the main directory to install the node module dependencies.

To build a development version of the framework, run `grunt dev`. To run a full build, which also produces the minified version and the individually minified modules for the custom build, run `grunt full`.  You can also run `grunt beta` to generate a beta version.   

If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in Gruntfile.js.

#Testing

[![Build Status](https://travis-ci.org/ericdrowell/KineticJS.png)](https://travis-ci.org/ericdrowell/KineticJS)

### Running the tests
KineticJS uses Mocha for testing.  Just open up test/runner.html to run the tests in your favorite browser.  To run the tests in PhantomJS, run `mocha-phantomjs test/runner.html` in the console. 

#Pull Requests
I'd be happy to review any pull requests that may better the KineticJS project, in particular if you have a bug fix, enhancement, or a new shape (see `src/shapes` for examples).  Before doing so, please first make sure that all of the tests pass, and also make sure that you don't have any jshint errors.  You can do so by running `grunt hint`
test change 2013-04-12 10:42:35 +08:00			`#Building the KineticJS Framework`
added beta task runner, and updated README 2013-07-28 14:26:06 +08:00			To build the framework, you need to have node installed. After that, run `npm install` in the main directory to install the node module dependencies.
Create a build script to concatenate and (optionaly) minify the files in the lib directory. 2012-03-06 09:59:41 +08:00
added beta task runner, and updated README 2013-07-28 14:26:06 +08:00			To build a development version of the framework, run `grunt dev`. To run a full build, which also produces the minified version and the individually minified modules for the custom build, run `grunt full`. You can also run `grunt beta` to generate a beta version.
Create a build script to concatenate and (optionaly) minify the files in the lib directory. 2012-03-06 09:59:41 +08:00
removed Ruby build files, and updated readme with Grunt instructions 2013-06-02 07:03:50 +08:00			`If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in Gruntfile.js.`
bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00
Kinetic.Animation constructor now just requires a function and optional node. No more config object 2012-11-16 13:30:58 +08:00			`#Testing`
restructured unit tests and created a unit test build target which concatenates source test files 2012-11-14 13:37:28 +08:00
removed status string from readme 2013-08-29 14:58:06 +08:00			`[![Build Status](https://travis-ci.org/ericdrowell/KineticJS.png)](https://travis-ci.org/ericdrowell/KineticJS)`
added travis ci images to readme 2013-08-29 14:55:42 +08:00
adjusted testing subtitle size 2012-12-04 12:12:38 +08:00			`### Running the tests`
updated readme with new test info 2013-09-11 12:47:14 +08:00			KineticJS uses Mocha for testing. Just open up test/runner.html to run the tests in your favorite browser. To run the tests in PhantomJS, run `mocha-phantomjs test/runner.html` in the console.
Kinetic.Animation constructor now just requires a function and optional node. No more config object 2012-11-16 13:30:58 +08:00
bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00			`#Pull Requests`
updated readme with new test info 2013-09-11 12:47:14 +08:00			I'd be happy to review any pull requests that may better the KineticJS project, in particular if you have a bug fix, enhancement, or a new shape (see `src/shapes` for examples). Before doing so, please first make sure that all of the tests pass, and also make sure that you don't have any jshint errors. You can do so by running `grunt hint`