Go to file
Tom Conroy c9c743ab99 Patch Snap.ajax to allow CORS GET requests 2014-04-29 15:33:00 -04:00
demos fix typos and tenses in tutorial 2013-11-05 13:45:43 +00:00
dist Added new method paper.use() 2014-04-22 19:09:21 +10:00
doc Added new method paper.use() 2014-04-22 19:09:21 +10:00
src Patch Snap.ajax to allow CORS GET requests 2014-04-29 15:33:00 -04:00
test Added paper.svg() method 2014-04-22 17:12:11 +10:00
.gitignore Fix for bug #24 2013-10-14 23:02:50 +11:00
.gitmodules Moving submodules (part 1) 2013-08-16 11:15:34 +10:00
CONTRIBUTING Added contributing file 2013-08-16 14:50:35 +10:00
Gruntfile.js Moved docs from dist/ to doc/ 2013-10-29 12:13:58 +11:00
LICENSE Add License 2013-08-15 18:31:27 +10:00
NOTICE Fix for bug #25 & #110 2013-11-18 23:02:11 +11:00
README.md Moved docs from dist/ to doc/ 2013-10-29 12:13:58 +11:00
bower.json Added new method paper.use() 2014-04-22 19:09:21 +10:00
component.json Fixes for #203 & #204 2014-03-07 10:45:24 +11:00
dr.json Updated to the new version of dr.js. Now with templates 2013-11-18 11:16:23 +11:00
package.json Added new method paper.use() 2014-04-22 19:09:21 +10:00
template.dot Fixed tests. Added new tests for class methods. Fix for bug #227 2014-04-22 13:56:47 +10:00

README.md

Snap.svg

A JavaScript SVG library for the modern web. Learn more at snapsvg.io.

Follow us on Twitter.

Learn

Use

In your HTML file, load simply by: <script src="snap.svg-min.js"></script> No other scripts are needed. Both the minified and uncompressed (for development) versions are in the /dist folder.

Build

Snap.svg uses Grunt to build.

  • Open the terminal from the Snap.svg directory:

      cd Snap.svg
    
  • Install its command line interface (CLI) globally:

      npm install -g grunt-cli
    

*You might need to use sudo npm, depending on your configuration.

  • Install dependencies with npm:

      npm install
    

*Snap.svg uses Grunt 0.4.0. You might want to read more on their website if you havent upgraded since a lot has changed.

  • Type grunt in the command line to build the files.
  • The results will be built into the release folder.
  • Alternatively type grunt watch to have the build run automatically when you make changes to source files.

Contribute

  • Fill out the CLA.

  • Fork the repo.

  • Create a branch:

      git checkout -b my_branch
    
  • Add your changes.

  • Commit your changes:

      git commit -am "Added some awesome stuff"
    
  • Push your branch:

      git push origin my_branch
    
  • Make a pull request to dev branch.

Note: Pull requests to other branches than dev or without filled CLA wouldnt be accepted.