snap.js/README.md

69 lines
2.0 KiB
Markdown
Raw Normal View History

[Snap.svg](http://snapsvg.io)
2013-07-05 04:56:18 +00:00
======
2013-10-22 17:23:59 +00:00
A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io).
2013-09-02 04:26:51 +00:00
2013-10-23 14:56:38 +00:00
[Follow us on Twitter.](https://twitter.com/snapsvg)
### Install
* [Bower](http://bower.io/) - `bower install snap.svg`
* Manual Minified - https://github.com/adobe-webplatform/Snap.svg/raw/master/dist/snap.svg-min.js
* Manual Unminified - https://raw.githubusercontent.com/adobe-webplatform/Snap.svg/master/dist/snap.svg.js
2013-10-23 13:53:40 +00:00
### Learn
2013-09-09 01:16:25 +00:00
2013-10-23 13:53:40 +00:00
* [About Snap.svg](http://snapsvg.io/about/)
* [Getting Started](http://snapsvg.io/start/)
2013-10-24 01:01:42 +00:00
* [API Reference](http://snapsvg.io/docs/)
2013-10-23 13:53:40 +00:00
2013-10-29 01:13:58 +00:00
### 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.
2013-10-23 13:53:40 +00:00
### Build
2013-09-09 01:16:25 +00:00
2013-10-22 17:23:59 +00:00
Snap.svg uses [Grunt](http://gruntjs.com/) to build.
2013-09-09 01:16:25 +00:00
2013-10-22 17:23:59 +00:00
* Open the terminal from the Snap.svg directory:
2013-09-09 01:16:25 +00:00
2013-10-14 12:40:21 +00:00
cd Snap.svg
2013-09-09 01:16:25 +00:00
2013-10-22 17:23:59 +00:00
* Install its command line interface (CLI) globally:
2013-09-09 01:16:25 +00:00
npm install -g grunt-cli
_*You might need to use `sudo npm`, depending on your configuration._
2013-10-22 17:23:59 +00:00
* Install dependencies with npm:
2013-09-09 01:16:25 +00:00
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 havent upgraded since a lot has changed._
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.
* Alternatively type `grunt watch` to have the build run automatically when you make changes to source files.
2013-10-23 13:53:40 +00:00
### Contribute
2013-10-23 20:53:23 +00:00
* [Fill out the CLA](http://snapsvg.io/contributions/).
2013-10-16 21:42:11 +00:00
* [Fork](https://help.github.com/articles/fork-a-repo) the repo.
* Create a branch:
git checkout -b my_branch
2013-10-16 21:42:11 +00:00
* Add your changes.
* Commit your changes:
git commit -am "Added some awesome stuff"
2013-10-16 21:42:11 +00:00
* Push your branch:
git push origin my_branch
* Make a [pull request](https://help.github.com/articles/using-pull-requests) to `dev` branch.
*Note:* Pull requests to other branches than `dev` or without filled CLA wouldnt be accepted.