snap.js/README.md

[Snap.svg](http://snapsvg.io)
======

A JavaScript library for modern SVG graphics.

API Reference is in `dist/reference.html`

### Building

Snap.svg uses [Grunt](http://gruntjs.com/) 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](http://gruntjs.com/getting-started) 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.
* 

## Contributing

Start by checking out our [Backlog](http://huboard.com/topcoat/topcoat/backlog). (Pls file issues against this repo.)

* [Fill out the CLA here](http://snapsvg.io/dev/snapsvg-cla.html)
* [fork](https://help.github.com/articles/fork-a-repo) 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](https://help.github.com/articles/using-pull-requests)
-												Updates to README and code sample for Snap.animate

											
										
										
											2013-10-15 20:20:01 +00:00
+								[Snap.svg](http://snapsvg.io)
-												Initial commit

											
										
										
											2013-07-05 04:56:18 +00:00
+								======
-												Updates to README and code sample for Snap.animate

											
										
										
											2013-10-15 20:20:01 +00:00
+								A JavaScript library for modern SVG graphics.
-												Added API Reference in TopCaoat style

											
										
										
											2013-09-02 04:26:51 +00:00
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
+								API Reference is in `dist/reference.html`
 								### Building
-												Change name to Snap.svg. Added dr.js to grunt via grunt-exec

											
										
										
											2013-09-25 05:52:57 +00:00
+								Snap.svg uses [Grunt](http://gruntjs.com/) to build
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Change name to Snap.svg. Added dr.js to grunt via grunt-exec

											
										
										
											2013-09-25 05:52:57 +00:00
+								* Open the terminal from the Snap.svg directory
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
-												Type in README

											
										
										
											2013-10-14 12:40:21 +00:00
+								        cd Snap.svg
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
 								* Install its command line interface (CLI) globally
 								        npm install -g grunt-cli
-												Updates to README and code sample for Snap.animate

											
										
										
											2013-10-15 20:20:01 +00:00
+								_*You might need to use `sudo npm`, depending on your configuration._
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
+								* Install dependencies with npm
 								        npm install
-												Change name to Snap.svg. Added dr.js to grunt via grunt-exec

											
										
										
											2013-09-25 05:52:57 +00:00
+								_*Snap.svg uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you haven’t upgraded since a lot has changed._
-												Update notice and readme

											
										
										
											2013-09-09 01:16:25 +00:00
 								* Type `grunt` in the command line to build the files.
 								* The results will be built into the release folder.
-												Update README.md

Added Contributing section
											
										
										
											2013-10-15 17:21:01 +00:00
+								* Alternatively type `grunt watch` to have the build run automatically when you make changes to source files.
 								*
 								## Contributing
 								Start by checking out our [Backlog](http://huboard.com/topcoat/topcoat/backlog). (Pls file issues against this repo.)
 								* [Fill out the CLA here](http://snapsvg.io/dev/snapsvg-cla.html)
 								* [fork](https://help.github.com/articles/fork-a-repo) 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](https://help.github.com/articles/using-pull-requests)