Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 1.76 KB

README.md

File metadata and controls

62 lines (36 loc) · 1.76 KB
Raw

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 haven’t 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 wouldn’t be accepted.