Install as usual using the Joomla! installer.
The module can automatically find articles with images, so there is no need to add any code to the articles themselves.
You can set the parameters for the module using the Joomla! module manager. The module uses sensible defaults, so to get you started you may only need to pick the articles that you wish to display. The parameters are shown using the links below:-
The slideshow can detect any images embedded using the html <img> tag. Often that is all that you need. However you may want the slideshow to use an image that you don't want to display in the linked article. In this case you can hide an image URL inside an html comment tag using the following format:-
<!--image:images/myimage.jpg-->
Replace 'images/myimage.jpg' with the actual image URL. The module will load any images in these special comment tags before it loads any normal images.
If you are using K2 the slideshow can also detect images loaded in the image field.
The main image width and height in pixels, and the thumbnail size.
Use image width or height when determining the size of images that don't fit into the image container due to differing proportions. If 'width' is selected, then the main images will be scaled so that their width is the same width as the image container. If 'height' is selected, then the height will be matched to the image container. In each case, any excess of the image will be cut off.
The best thing is to experiment with this setting, and see what is most acceptable for your site.
Set this to yes to resize images. Use this if your images are bigger than the size displayed in the slideshow, or if you want to compress images. The original images will not be changed, the resized images will be written to a cache folder within the module.
In subsequent displays of the module the cached images will be used, to improve performance.
Image quality is a value ranging between 0 (worst quality) to 100 (best quality). If your images are good quality to start with then you may be able to reduce the quality down to about 75 without bad effects, and the resulting compression can reduce the file size quite a bit, and will speed loading the slideshow. If your images are already compressed though the results will probably not be good.