README.txt 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. INTRODUCTION
  2. ------------
  3. * Views Slideshow can be used to create a slideshow of any content (not just
  4. images) that can appear in a View. Powered by jQuery, it is heavily
  5. customizable: you may choose slideshow settings for each View you create.
  6. REQUIREMENTS
  7. ------------
  8. * Views Slideshow 8.x-4.x requires Drupal 8 & the core views module enabled.
  9. * There is no upgrade path from views slideshow for Drupal 7.
  10. INSTALLATION
  11. ------------
  12. * Install as you would normally install a contributed Drupal module. See the
  13. <a href='http://drupal.org/documentation/install/modules-themes/modules-8'>
  14. Drupal 8 instructions</a> if required in the Drupal documentation for further
  15. information. Note there are two modules included in this project; "Views
  16. Slideshow" & "Views Slideshow Cycle". In most cases you will need/want to
  17. enable both of them.
  18. * You will also need to download some JavaScript libraries. You can do this
  19. semi-automatically via drush using `drush dl-cycle-lib` or if preferred,
  20. manually from the sources.
  21. * Required libraries
  22. * https://malsup.github.io/jquery.cycle.all.js
  23. * http://cherne.net/brian/resources/jquery.hoverIntent.js
  24. * https://raw.githubusercontent.com/douglascrockford/JSON-js/master/json2.js
  25. * an example of code you could run in your Drupal root directory to download
  26. to the right place:
  27. ```
  28. mkdir -p libraries/jquery.cycle && cd $_ && wget https://malsup.github.io/jquery.cycle.all.js \
  29. && mkdir -p ../../libraries/jquery.hoverIntent && cd $_ && wget http://cherne.net/brian/resources/jquery.hoverIntent.js \
  30. && mkdir -p ../../libraries/json2 && cd $_ && wget https://raw.githubusercontent.com/douglascrockford/JSON-js/master/json2.js
  31. ```
  32. CONFIGURATION
  33. -------------
  34. * Configuration is on a per view/display basis. Select 'Slideshow' as the
  35. display format and then configure settings as desired under Format
  36. Settings.
  37. * See also:
  38. https://www.ostraining.com/blog/drupal/drupal-8-slideshows
  39. MAINTAINERS
  40. -----------
  41. Current maintainers:
  42. * vbouchet (https://www.drupal.org/u/vbouchet) (Initial port & primary 8.x-4.x maintainer)
  43. * NickWilde (https://www.drupal.org/u/nickwilde) (Secondary 8.x-4.x maintainer)
  44. * aaron (https://www.drupal.org/u/aaron)
  45. * xiukun.zhou (https://www.drupal.org/u/xiukun.zhou)
  46. * wangqizhong (https://www.drupal.org/u/wangqizhong)