An Open Source library for multi-touch, WebGL powered applications.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

52 lines
1.0 KiB

3 years ago
3 years ago
2 years ago
3 years ago
  1. # iwmlib
  2. ## Install
  3. Install the following dependencies globally
  4. `npm i rollup gulp-cli -g`
  5. and some dependencies locally
  6. `npm i`
  7. ## Build
  8. To build the iwmlib files type
  9. `npm run build`
  10. The files
  11. - imwlib.js
  12. - iwmlib.pixi.js
  13. will be generated in the dist folder. If you want to build the files continuously type
  14. `npm run watch`
  15. To build the 3rd party library type
  16. `npm run 3rdparty`
  17. ## Docs
  18. To create the documentation in the folder ./doc/out type `npm run jsdoc`
  19. Afterwards you can view the documentation here:
  20. - The iwmlib [DocTests](./lib/index.html)
  21. - The iwmlib [PixiJS DocTests](./lib/pixi/index.html)
  22. ## Useful PixiJS Resources
  23. Currently using PixiJS version 4
  24. - The PixiJS [JavaScript API Docs](http://pixijs.download/dev/docs/index.html)
  25. - The PixiJS [Examples](http://pixijs.github.io/examples/#/basics/basic.js)
  26. - The PixiJS [GitHub Repository](https://github.com/pixijs/pixi.js)
  27. ## List of 3<sup>rd</sup> party libraries included
  28. - [PixiJS](http://www.pixijs.com)
  29. - [Greensock](https://greensock.com) with TweenMax and TimelineMax