konva/README.md

#Hiatus

Hi all! I will be taking a 3 month break from KineticJS (until July 2014) to focus on other endeavors.  KineticJS is in a great state right now (v5.1.0).  Please continue to file any issues that you may find, or submit pull requests.  They will eventually be addressed.

# Setuping dev environment

Before doing all dev stuff make sure you have node installed. After that, run `npm install --dev` in the main directory to install the node module dependencies.

Run `grunt --help` to see all build options.

#Building the KineticJS Framework 

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)

KineticJS uses Mocha for testing. 

* If you need run test only one time run `grunt test`.
* While developing it is easy to use `grunt server` with watch task. Just run it and go to [http://localhost:8080/test/runner.html](http://localhost:8080/test/runner.html). After src file change kinetic-dev.js will be automatically created, so you just need refresh test the page.

KineticJS is covered with hundreds of tests and well over a thousand assertions.  KineticJS uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test. 

#Generation documentation

Run `grunt docs` which will build the documentation files and place them in the docs folder.

#NodeJS

Support of NodeJS is experimental.

We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create canvas element.

###Installation

1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](https://github.com/LearnBoost/node-canvas/wiki/_pages)
2. `npm install jsdom`
3. `npm install kinetic`

###Example

See file `nodejs-demo.js`.

#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 (`grunt test`).
Update README.md 2014-04-10 00:19:50 +08:00			`#Hiatus`

			`Hi all! I will be taking a 3 month break from KineticJS (until July 2014) to focus on other endeavors. KineticJS is in a great state right now (v5.1.0). Please continue to file any issues that you may find, or submit pull requests. They will eventually be addressed.`

typo fix 2014-04-18 09:12:10 +08:00			`# Setuping dev environment`
Update README.md 2014-04-10 00:19:50 +08:00
Alpha nodejs support 2014-02-27 19:55:39 +08:00			Before doing all dev stuff make sure you have node installed. After that, run `npm install --dev` in the main directory to install the node module dependencies.
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
			Run `grunt --help` to see all build options.

test change 2013-04-12 10:42:35 +08:00			`#Building the KineticJS Framework`
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
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00			`KineticJS uses Mocha for testing.`

			* If you need run test only one time run `grunt test`.
Several README typo fixes 2014-02-27 18:51:33 +08:00			* While developing it is easy to use `grunt server` with watch task. Just run it and go to [http://localhost:8080/test/runner.html](http://localhost:8080/test/runner.html). After src file change kinetic-dev.js will be automatically created, so you just need refresh test the page.
updated the readme with new test info 2013-09-11 12:51:07 +08:00
updated readme again 2013-09-11 12:52:11 +08:00			`KineticJS is covered with hundreds of tests and well over a thousand assertions. KineticJS uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.`
Kinetic.Animation constructor now just requires a function and optional node. No more config object 2012-11-16 13:30:58 +08:00
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00			`#Generation documentation`

Update README.md 2014-03-28 14:41:42 +08:00			Run `grunt docs` which will build the documentation files and place them in the docs folder.
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
Alpha nodejs support 2014-02-27 19:55:39 +08:00			`#NodeJS`

npm ready 2014-04-17 17:58:51 +08:00			`Support of NodeJS is experimental.`
Alpha nodejs support 2014-02-27 19:55:39 +08:00
npm ready 2014-04-17 17:58:51 +08:00			`We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create canvas element.`
Alpha nodejs support 2014-02-27 19:55:39 +08:00
typo fix 2014-04-18 09:12:10 +08:00			`###Installation`
npm ready 2014-04-17 17:58:51 +08:00
			`1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](https://github.com/LearnBoost/node-canvas/wiki/_pages)`
			2. `npm install jsdom`
			3. `npm install kinetic`
Alpha nodejs support 2014-02-27 19:55:39 +08:00
			`###Example`
update NodeJS example 2014-03-04 19:40:06 +08:00
			See file `nodejs-demo.js`.
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +08:00
bug fixes and enhancements. also updated the README 2012-03-11 08:52:16 +08:00			`#Pull Requests`
http://localhost:8080/test/runner.html 2014-02-27 18:46:15 +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 (`grunt test`).