Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Serge G. Spaolonzi committed Apr 19, 2012
1 parent b48f69e commit 3aefe14
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.rst
Expand Up @@ -15,35 +15,30 @@ Requierements
Use
---

1. Download JZoopraxiscope and link the jquery.jzoopraxiscope.js file in your page:

.. code:: html
1. Download JZoopraxiscope and link the jquery.jzoopraxiscope.js file in your page::
<script src="jquery.jzoopraxiscope.js"></script>


2. Link the jQuery and jQuery UI libraries in your page:
.. code:: html
2. Link the jQuery and jQuery UI libraries in 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 sequense. Every frame must have the same width and be attached to his previous frame in a horizontal image. Refer to the included file 'media/jzoo.jpg'

----------+------------+------------+------------+
+------------+------------+------------+------------+
| Frame 1 | Frame 2 | Frame 3 | Frame 4 |
+------------+------------+------------+------------+

*Horizontal image*


4. Define the options

.. code:: javascript
4. Define the options::
var optionsAnimation = {
'widthItem' : 380,
'widthImage' : 4560,
'height' : 306,
'image' : 'images/jzoo.jpg'
}
'image' : 'images/jzoo.jpg'}

widthItem
Width of every frame.
Expand All @@ -55,19 +50,14 @@ 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).

.. code:: html
5. Initialize a div with JZoo (#animation)::
<div id="animation" style="border: 1px solid #999; margin: auto;"></div>


.. code:: javascript
Javascript code::
$('#animation').jzoopraxiscope(optionsAnimation);

6. Control JZoo.

.. code:: javascript
6. Control JZoo::
//Play the animation
$('#animation').jzoopraxiscope('play');
Expand Down

0 comments on commit 3aefe14

Please sign in to comment.