aboutsummaryrefslogtreecommitdiffstats
path: root/dcae_dmaapbc_webapp/src/main/webapp/app/fusion/ase/scripts/bower_components/Snap.svg/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dcae_dmaapbc_webapp/src/main/webapp/app/fusion/ase/scripts/bower_components/Snap.svg/README.md')
-rw-r--r--dcae_dmaapbc_webapp/src/main/webapp/app/fusion/ase/scripts/bower_components/Snap.svg/README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/dcae_dmaapbc_webapp/src/main/webapp/app/fusion/ase/scripts/bower_components/Snap.svg/README.md b/dcae_dmaapbc_webapp/src/main/webapp/app/fusion/ase/scripts/bower_components/Snap.svg/README.md
new file mode 100644
index 0000000..8040710
--- /dev/null
+++ b/dcae_dmaapbc_webapp/src/main/webapp/app/fusion/ase/scripts/bower_components/Snap.svg/README.md
@@ -0,0 +1,68 @@
+[Snap.svg](http://snapsvg.io)
+======
+
+A JavaScript SVG library for the modern web. Learn more at [snapsvg.io](http://snapsvg.io).
+
+[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
+
+
+### Learn
+
+* [About Snap.svg](http://snapsvg.io/about/)
+* [Getting Started](http://snapsvg.io/start/)
+* [API Reference](http://snapsvg.io/docs/)
+
+### 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](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.
+
+### Contribute
+
+* [Fill out the CLA](http://snapsvg.io/contributions/).
+* [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) to `dev` branch.
+
+*Note:* Pull requests to other branches than `dev` or without filled CLA wouldn’t be accepted.