Skip to content
Browse files

Multiple Changes

  • Loading branch information...
1 parent ef81aab commit fb6f1ecb99e0e7d56bafb38e2910b5ba98c4748d @cobalys committed
Showing with 35 additions and 27 deletions.
  1. +3 −0 .gitignore
  2. +7 −4 LICENSE
  3. +25 −23 README.md → README.rst
  4. BIN media/Logo.png
  5. BIN media/jzoo.jpg
View
3 .gitignore
@@ -0,0 +1,3 @@
+.project
+.directory
+.settings
View
11 LICENSE
@@ -1,9 +1,12 @@
-JZoopraxiscope jQuery Plugin v1.0.0
+JZoopraxiscope jQuery Plugin
+============================
+Copyright 2012 dual license GPLv3 and MIT, serge@cobalys.com
+
http://www.cobalys.com/open-source/jzoopraxiscope.html
-Copyright 2012, serge@cobalys.com
-The code is released under dual licence MIT and GPLv3.
-'JZoopraxiscopeLogo.svg' and 'Logo.png' by serge@cobalys.com are licensed under a Creative Commons Attribution 3.0 Unported License.
+ * The code is released under dual licence MIT and GPLv3.
+ * 'JZoopraxiscopeLogo.svg' and 'logo.png' by serge@cobalys.com are licensed under a Creative Commons Attribution 3.0 Unported License.
+ * Image jzoo.jpg belongs to the Eadweard Muybridge Collection (Public Domain).
More information GPL-LICENSE, CCA-LICENSE and MIT-LICENSE files included.
View
48 README.md → README.rst
@@ -1,51 +1,53 @@
+==============
JZoopraxiscope
==============
-http://www.cobalys.com/open-source/jzoopraxiscope.html
-https://github.com/cobalys/JZoopraxiscope
-### Animate static image sequences with this jQuery plugin.
+ * http://www.cobalys.com/open-source/jzoopraxiscope.html
+ * https://github.com/cobalys/JZoopraxiscope
JZoopraxiscope is a jQuery plugin for making animations from static images inspired in Eadweard Muybridge's Zoopraxiscope.
Requirements
-------------
-* JQuery
-* JQuery UI
-* An image representing the sequence to be animated
+
+ * JQuery
+ * JQuery UI
+ * An image representing the sequence to be animated
Browser Compatibility
---------------------
-* Chrome 18.0.1025.162
-* Mozilla Firefox 11.0
-* Internet Explorer 8
-* Safari 5
-* Opera 11.62
+
+ * Chrome 18.0.1025.162
+ * Mozilla Firefox 11.0
+ * Internet Explorer 8
+ * Safari 5
+ * Opera 11.62
Use
---
-1. Download JZoopraxiscope and reference the jquery.jzoopraxiscope.js file in your page.
+1. Download JZoopraxiscope and reference the jquery.jzoopraxiscope.js file from your page::
<script src="jquery.jzoopraxiscope.js"></script>
-2. Reference jQuery and jQuery UI libraries from your page
+2. Reference jQuery and jQuery UI libraries from your page::
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.18/jquery-ui.js"></script>
-3. Prepare the static sequence. Every frame must have the same width and be attached to his previous frame in a horizontal image. Refer to the included file 'jzoo.jpg'
-<pre>
+3. Prepare the static sequence. Every frame must have the same width and be attached to his previous frame in a horizontal image. Refer to the included file 'jzoo.jpg'::
+
+------------+------------+------------+------------+
| Frame 1 | Frame 2 | Frame 3 | Frame 4 |
+------------+------------+------------+------------+
-</pre>
-4. Define the options
+
+4. Define the options::
var optionsAnimation = {
'widthItem' : 380,
@@ -53,13 +55,13 @@ Use
'height' : 306,
'image' : 'images/jzoo.jpg'}
- **widthItem**: Width of every frame.
- **widthImage**: Width of the entire image.
- **height**: Height of the image.
- **image**: Location of the image. Use relative or absolute path, relative paths are related to the html document where the plugin is installed.
+ :widthItem: Width of every frame.
+ :widthImage: Width of the entire image.
+ :height: Height of the image.
+ :image: Location of the image. Use relative or absolute path, relative paths are related to the html document where the plugin is installed.
-5. Initialize a div with JZoo (#animation)
+5. Initialize a div with JZoo (#animation)::
//Html
<div id="animation" style="border: 1px solid #999; margin: auto;"></div>
@@ -68,7 +70,7 @@ Use
$('#animation').jzoopraxiscope(optionsAnimation);
-6. Control JZoo
+6. Control JZoo::
//Play the animation
$('#animation').jzoopraxiscope('play');
View
BIN media/Logo.png
Deleted file not rendered
View
BIN media/jzoo.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fb6f1ec

Please sign in to comment.
Something went wrong with that request. Please try again.