Chris@5: INTRODUCTION
Chris@5: ------------
Chris@5: 
Chris@5:   * Views Slideshow can be used to create a slideshow of any content (not just
Chris@5:     images) that can appear in a View. Powered by jQuery, it is heavily
Chris@5:     customizable: you may choose slideshow settings for each View you create.
Chris@5: 
Chris@5: 
Chris@5: REQUIREMENTS
Chris@5: ------------
Chris@5: 
Chris@5:   * Views Slideshow 8.x-4.x requires Drupal 8 & the core views module enabled.
Chris@5: 
Chris@5:   * There is no upgrade path from views slideshow for Drupal 7.
Chris@5: 
Chris@5: 
Chris@5: INSTALLATION
Chris@5: ------------
Chris@5:   * Install as you would normally install a contributed Drupal module. See the
Chris@5:   <a href='http://drupal.org/documentation/install/modules-themes/modules-8'>
Chris@5:   Drupal 8 instructions</a> if required in the Drupal documentation for further
Chris@5:   information. Note there are two modules included in this project; "Views
Chris@5:   Slideshow" & "Views Slideshow Cycle". In most cases you will need/want to
Chris@5:   enable both of them.
Chris@5: 
Chris@5:   * You will also need to download some JavaScript libraries. You can do this
Chris@5:   semi-automatically via drush using `drush dl-cycle-lib` or if preferred,
Chris@5:   manually from the sources.
Chris@5: 
Chris@5:   * Required libraries
Chris@5:     * https://malsup.github.io/jquery.cycle.all.js
Chris@5:     * https://raw.githubusercontent.com/briancherne/jquery-hoverIntent/master/jquery.hoverIntent.js
Chris@5:     * https://raw.githubusercontent.com/douglascrockford/JSON-js/master/json2.js
Chris@5: 
Chris@5:   * an example of code you could run in your Drupal root directory to download
Chris@5:     to the right place:
Chris@5: 
Chris@5:     ```
Chris@5:     mkdir -p libraries/jquery.cycle && cd $_ && wget https://malsup.github.io/jquery.cycle.all.js \
Chris@5:     && mkdir -p ../../libraries/jquery.hoverIntent && cd $_ && wget https://raw.githubusercontent.com/briancherne/jquery-hoverIntent/master/jquery.hoverIntent.js \
Chris@5:     && mkdir -p ../../libraries/json2 && cd $_ && wget https://raw.githubusercontent.com/douglascrockford/JSON-js/master/json2.js
Chris@5:     ```
Chris@5: 
Chris@5: CONFIGURATION
Chris@5: -------------
Chris@5: 
Chris@5:   * Configuration is on a per view/display basis. Select 'Slideshow' as the
Chris@5:     display format and then configure settings as desired under Format
Chris@5:     Settings.
Chris@5: 
Chris@5:   * See also:
Chris@5:         https://www.ostraining.com/blog/drupal/drupal-8-slideshows
Chris@5: 
Chris@5: 
Chris@5: MAINTAINERS
Chris@5: -----------
Chris@5: 
Chris@5: Current maintainers:
Chris@5: 
Chris@5:   * vbouchet (https://www.drupal.org/u/vbouchet) (Initial port & primary 8.x-4.x maintainer)
Chris@5: 
Chris@5:   * NickWilde (https://www.drupal.org/u/nickwilde) (Secondary 8.x-4.x maintainer)
Chris@5: 
Chris@5:   * aaron (https://www.drupal.org/u/aaron)
Chris@5: 
Chris@5:   * xiukun.zhou (https://www.drupal.org/u/xiukun.zhou)
Chris@5: 
Chris@5:   * wangqizhong (https://www.drupal.org/u/wangqizhong)