Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 50 lines (27 sloc) 2.434 kb
a65ab0e @ericdrowell Update README.md
authored
1 ##Mothballed
accd40a @ericdrowell Update README.md
authored
2
a65ab0e @ericdrowell Update README.md
authored
3 Hi all! I will no longer be maintaining this repo or the official KineticJS website because I have moved onto other ventures and projects. The latest version of KineticJS, 5.1.0, is very solid and can still be used in production applications. Please feel free to fork the repo if you'd like to make changes.
35c1b4e @lavrton Add link to fork
lavrton authored
4
accd40a @ericdrowell Update README.md
authored
5 Also, you can now find tars of every stable KineticJS build on [www.kineticjs.com](http://www.kineticjs.com)
d1624f5 @ericdrowell Update README.md
authored
6
52e8bbe @lavrton update installation notes
lavrton authored
7 #Installation
8
6912c77 @hellocreep bower package name fixed
hellocreep authored
9 * `bower install kineticjs`
654cbf2 @lavrton typo fix
lavrton authored
10 * `npm install kinetic` - for Browserify. For nodejs you have to install some [dependencies](#NodeJS)
52e8bbe @lavrton update installation notes
lavrton authored
11
12 ###NodeJS
13
14 Support of NodeJS is experimental.
15
16 We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create canvas element.
17
18 1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](https://github.com/LearnBoost/node-canvas/wiki/_pages)
19 2. `npm install jsdom`
20 3. `npm install kinetic`
21
22 See file `nodejs-demo.js` for example.
23
24 #Dev environment
d1624f5 @ericdrowell Update README.md
authored
25
c8ddd27 @lavrton Alpha nodejs support
lavrton authored
26 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.
7c5794f @lavrton http://localhost:8080/test/runner.html
lavrton authored
27
28 Run `grunt --help` to see all build options.
29
52e8bbe @lavrton update installation notes
lavrton authored
30 ##Building the KineticJS Framework
ac80261 @magicienap Create a build script to concatenate and (optionaly) minify the files in...
magicienap authored
31
7e660d0 @ericdrowell added beta task runner, and updated README
authored
32 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.
ac80261 @magicienap Create a build script to concatenate and (optionaly) minify the files in...
magicienap authored
33
2409b99 @ericdrowell removed Ruby build files, and updated readme with Grunt instructions
authored
34 If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in Gruntfile.js.
07860a7 @ericdrowell bug fixes and enhancements. also updated the README
authored
35
52e8bbe @lavrton update installation notes
lavrton authored
36 ##Testing
a5e23c4 @ericdrowell restructured unit tests and created a unit test build target which conca...
authored
37
8e5e3e2 @ericdrowell removed status string from readme
authored
38 [![Build Status](https://travis-ci.org/ericdrowell/KineticJS.png)](https://travis-ci.org/ericdrowell/KineticJS)
e94cd69 @ericdrowell added travis ci images to readme
authored
39
7c5794f @lavrton http://localhost:8080/test/runner.html
lavrton authored
40 KineticJS uses Mocha for testing.
41
42 * If you need run test only one time run `grunt test`.
5f931cf @lavrton Several README typo fixes
lavrton authored
43 * 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.
f4bd464 @ericdrowell updated the readme with new test info
authored
44
029348e @ericdrowell updated readme again
authored
45 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.
1913fed @ericdrowell Kinetic.Animation constructor now just requires a function and optional ...
authored
46
eee66e4 @lavrton Update README.md
lavrton authored
47 ##Generate documentation
7c5794f @lavrton http://localhost:8080/test/runner.html
lavrton authored
48
f01f426 @ericdrowell Update README.md
authored
49 Run `grunt docs` which will build the documentation files and place them in the docs folder.
Something went wrong with that request. Please try again.