lsm/konva
1
0
Fork 0
mirror of https://github.com/konvajs/konva.git synced 2025-04-05 20:48:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

added beta task runner, and updated README

Browse Source
This commit is contained in:
Eric Rowell 2013-07-27 23:26:06 -07:00
parent e5c52a92f0
commit 7e660d0587
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Gruntfile.js
View File

@ -116,6 +116,23 @@ module.exports = function(grunt) {
dest: 'dist/kinetic-dev.js'
}]
},
beta: {
options: {
variables: {
version: '<%= pkg.version %>-beta',
date: '<%= grunt.template.today("yyyy-mm-dd") %>',
nodeParams: '<%= grunt.file.read("doc-includes/NodeParams.txt") %>',
containerParams: '<%= grunt.file.read("doc-includes/ContainerParams.txt") %>',
shapeParams: '<%= grunt.file.read("doc-includes/ShapeParams.txt") %>'
},
prefix: '@@'
},
files: [{
src: ['dist/kinetic-v<%= pkg.version %>-beta.js'],
dest: 'dist/kinetic-v<%= pkg.version %>-beta.js'
}]
},
prod1: {
options: {
variables: {
@ -199,6 +216,7 @@ module.exports = function(grunt) {
// Tasks
grunt.registerTask('dev', ['clean', 'concat:dev', 'replace:dev']);
grunt.registerTask('beta', ['clean', 'concat:beta', 'replace:beta']);
grunt.registerTask('full', ['clean', 'concat:prod', 'uglify', 'replace:prod1', 'replace:prod2', 'replace:prod3']);
grunt.registerTask('test', ['concat:test']);
grunt.registerTask('hint', ['clean', 'concat:dev', 'replace:dev', 'jshint']);

6
README.md
View File

@ -1,14 +1,14 @@
#Building the KineticJS Framework
To build the framework, you need to have node and grunt installed. After that, run `npm install` to install the node module dependencies.
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`.
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
### 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 `grunt test` and then opening `unitTests.html`. Open `tests/html/index.html` to navigate to different test suites.
Currently, KineticJS has unit, functional, visual, manual, performance, and special test suites. Open `tests/html/index.html` to run each test suite. Before running any of the tests, be sure to build a dev version first with `grunt dev`. To build the unit tests, you'll need to build the `unitTests.js` file by running `grunt test` and then opening `unitTests.html`.
### Running the tests
Unit, functional, and performance tests output the results to the console via `console.log()` so be sure to have it open.