konva/README.md

#Building the KineticJS library
To build the library, you need to have Ruby and Rubygems installed. After that, run `gem install thor`, `gem install json_pure`, and `gem install uglifier` to install the dependencies.

To build a development version of the library, run `thor build:dev VERSION`, where VERSION is a string that can be anything you like. For example, using `thor build:dev current` will produce `kinetic-vcurrent.js`. To build a minified version of the library, run `thor build:prod VERSION`.   

If you add a file in the src directory, be sure to add the filename to the filename array in the Thorfile.

#Testing

## Getting the tests up and running
Currently, KineticJS has unit, functional, performance, manual, and special test suites.  To build the unit tests, you'll need to build the `unitTests.js` file by running `thor build:test` and then opening `unitTests.html`.  Open `tests/html/index.html` to navigate to different test suites.  

## Running the tests
Unit, functional, and performance tests output the results to the console via `console.log()` so be sure to have it open.  

In order for the data url tests and image manipulation tests to pass, you need to run the unit test suite on a web server due to canvas security constraints ([read more about that here](http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#security-with-canvas-elements)).  All tests should pass in Google Chrome with no warnings, and all tests should pass with some warnings in other browsers.  

## Updating the tests

To add / modify unit tests, be sure to do so in the `tests/js/unit` directory, because these are the source test files that are concatenated together when building `unitTests.js`.  Use `test()` for hard tests which will throw an error if something fails, and use `warn()` for soft tests that will allow the tests to continue if the test condition fails.  The `warn()` method is great for tests that will have different results in different browsers, such as canvas data url comparisons, text metric dimensions, etc.  

TIP: prepend a test name with a `*` to only run that particular test, or prepend a test name with `!` to omit that test.

#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 unit tests and functional tests pass.
finished transition code, complete with callback option whenever a transition is completed. All numeric Node properties can be transitioned. Will add easing function options later 2012-03-14 12:16:25 +08:00			`#Building the KineticJS library`
get() now returns a Node.Array array which has node methods. This means that you can do stuff like layer.get('.shape').setX(300) 2012-09-23 12:27:44 +08:00			To build the library, you need to have Ruby and Rubygems installed. After that, run `gem install thor`, `gem install json_pure`, and `gem install uglifier` to install the dependencies.
Create a build script to concatenate and (optionaly) minify the files in the lib directory. 2012-03-06 09:59:41 +08:00
improved Testing README 2012-12-04 12:11:31 +08:00			To build a development version of the library, run `thor build:dev VERSION`, where VERSION is a string that can be anything you like. For example, using `thor build:dev current` will produce `kinetic-vcurrent.js`. To build a minified version of the library, run `thor build:prod VERSION`.
Create a build script to concatenate and (optionaly) minify the files in the lib directory. 2012-03-06 09:59:41 +08:00
bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00			`If you add a file in the src directory, be sure to add the filename to the filename array in the Thorfile.`

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
improved Testing README 2012-12-04 12:11:31 +08:00			`## Getting the tests up and running`
			Currently, KineticJS has unit, functional, performance, manual, and special test suites. To build the unit tests, you'll need to build the `unitTests.js` file by running `thor build:test` and then opening `unitTests.html`. Open `tests/html/index.html` to navigate to different test suites.

			`## Running the tests`
			Unit, functional, and performance tests output the results to the console via `console.log()` so be sure to have it open.

			`In order for the data url tests and image manipulation tests to pass, you need to run the unit test suite on a web server due to canvas security constraints ([read more about that here](http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#security-with-canvas-elements)). All tests should pass in Google Chrome with no warnings, and all tests should pass with some warnings in other browsers.`

			`## Updating the tests`

			To add / modify unit tests, be sure to do so in the `tests/js/unit` directory, because these are the source test files that are concatenated together when building `unitTests.js`. Use `test()` for hard tests which will throw an error if something fails, and use `warn()` for soft tests that will allow the tests to continue if the test condition fails. The `warn()` method is great for tests that will have different results in different browsers, such as canvas data url comparisons, text metric dimensions, etc.
bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00
prepend tests with a ! to omit a particular test from the test suite 2012-11-16 13:33:39 +08:00			TIP: prepend a test name with a `*` to only run that particular test, or prepend a test name with `!` to omit that test.
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`
refactored event bindings to expose content node events and enable true functional tests without a test framework like Selenium. Added new manualTests.html page for manual tests. One of the manual tests has already been converted to a functional test. Will add in image data url hashmaps soon so that I can compare screenshots before and after a series of actions in the functional tests 2012-06-16 02:47:55 +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 unit tests and functional tests pass.