hdimo / cycle2

2nd gen cycling

Cycle2 - 2nd Generation Cycling!

Getting Started

Download either the production version or the development version of Cycle2.

In your web page:

<!-- include jQuery -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js"></script>
<!-- include Cycle2 -->
<script src="http://path/to/your/copy/of/jquery.cycle2.min.js"></script>

...

<!-- declare a slideshow -->
<div class="cycle-slideshow">
    <img src="http://malsup.github.com/images/p1.jpg">
    <img src="http://malsup.github.com/images/p2.jpg">
    <img src="http://malsup.github.com/images/p3.jpg">
</div>

That's it! You don't need to write any script to initialize the slideshow, Cycle2 will auto-initialize if you use the class cycle-slideshow.

Documentation, Demos, Downloads and FAQ

Everything you need to know can be found here: http://jquery.malsup.com/cycle2/

Bower

To install Cycle2 via Bower:

bower install jquery-cycle2

The only file you will need (unless you're customizing) is build/jquery.cycle2.min.js

(Other files are available for advanced customization and you can read more about them on the download and advanced download pages.)

Build

If you want to make changes to Cycle2 and build it yourself, you can do so by installing the node build dependencies:

npm install

and then running grunt

grunt

Copyright and License

Copyright © 2012-2014 M. Alsup.

The Cycle2 plugin is dual licensed under the MIT and GPL licenses.

You may use either license. The MIT license is recommended for most projects because it is simple and easy to understand and it places almost no restrictions on what you can do with the plugin.

If the GPL suits your project better you are also free to use the plugin under that license.

You do not have to do anything special to choose one license or the other and you don't have to notify anyone which license you are using. You are free to use the Cycle2 plugin in commercial projects as long as the copyright header is left intact.