Go to file
cjgammon ba87d18044 organize demos in demo folder 2013-10-15 12:12:47 -07:00
demos organize demos in demo folder 2013-10-15 12:12:47 -07:00
dist Fix for bug #35 & #36 2013-10-15 12:32:49 +11:00
src Fix for bug #27 2013-10-15 11:12:33 +11:00
test Fix for bug #24 2013-10-14 23:02:50 +11: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 Change name to Snap.svg. Added dr.js to grunt via grunt-exec 2013-09-25 15:52:57 +10:00
LICENSE Add License 2013-08-15 18:31:27 +10:00
NOTICE Change name to Snap.svg. Added dr.js to grunt via grunt-exec 2013-09-25 15:52:57 +10:00
README.md Update README.md 2013-10-15 10:21:01 -07:00
dr.json Change name to Snap.svg. Added dr.js to grunt via grunt-exec 2013-09-25 15:52:57 +10:00
package.json Change name to Snap.svg. Added dr.js to grunt via grunt-exec 2013-09-25 15:52:57 +10:00

README.md

Snap.svg

JavaScript library for SVG.

API Reference is in dist/reference.html

Building

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
    
  • 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.

Contributing

Start by checking out our Backlog. (Pls file issues against this repo.)

  • Fill out the CLA here

  • 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