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

update readme for new gulp builder. close #73

Browse Source
This commit is contained in:
Anton Lavrenov 2015-05-04 16:15:16 +07:00
parent 7b1db3839e
commit f6e2cf19a3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -39,11 +39,11 @@ See [CHANGELOG.md](https://github.com/konvajs/konva/blob/master/CHANGELOG.md).
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.
Run `gulp -T` to see all build options.
##Building the Konva 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.
To build a development version of the framework, run `gulp dev-build`. To run a full build, which also produces the minified version run `gulp build`.
If you add a file in the src directory, be sure to add the filename to the sourceFiles array variable in `gulpfile.js`.
@ -51,17 +51,17 @@ If you add a file in the src directory, be sure to add the filename to the sourc
Konva 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 konva-dev.js will be automatically created, so you just need refresh test the page.
* If you need run test only one time run `gulp test`.
* While developing it is easy to use `gulp` default task with with watch. Just run it and go to [http://localhost:8080/test/runner.html](http://localhost:8080/test/runner.html). After src file change konva-dev.js will be automatically created, so you just need refresh test the page.
Konva is covered with hundreds of tests and well over a thousand assertions.
Konva uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.
##Generate documentation
Run `grunt docs` which will build the documentation files and place them in the docs folder.
Run `gulp api` which will build the documentation files and place them in the `api` folder.
#Pull Requests
I'd be happy to review any pull requests that may better the Konva 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`).
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 (`gulp lint test`).