Commits

Anonymous committed 88f8d8a

readme

  • Participants
  • Parent commits 7cc279a

Comments (0)

Files changed (2)

 ====================
 cmsplugin-nivoslider
 ====================
+
+Simple image slider plugin.
+Shows the widely used jquery Nivo slider plugin from http://nivo.dev7studios.com/
+
+Features:
+
+- Three default nivo slider theme choices
+- Auto-discovering of custom nivo themes on static/nivo/themes
+- Uses width and height from nivo themes css spec headers
+  (as explained in http://nivo.dev7studios.com/support/advanced-tutorials/creating-custom-themes-for-the-nivo-slider/)
+- User selection of nivo parameters: nivo theme, animation effect, speed, pause...
+
+Requires:
+- easy-thumbnails http://pypi.python.org/pypi/easy-thumbnails/
+
+
+Installation
+============
+
+#. `pip install cmsplugin_nivoslider`
+#. Add `'cmsplugin_nivoslider'` to `INSTALLED_APPS`
+#. Run `syncdb` or `./manage.py migrate cmsplugin_nivoslider` if using south
+
+You need to have correctly configured staticfiles for autodiscovering and using themes
+
+Using a custom or downloaded theme
+==================================
+When reloading your django app, the plugin will search for themes on the following
+static dir: `nivo/themes/`
+
+So all you need to do is put your theme under the directory:
+`STATIC_ROOT/nivo/themes/pluginname`
+
+:author bcabezas@apsl.net - http://www.apsl.net/
+:date: 2012/03/14
     license='MIT',
     description = "Simple Nivo Slider plugin for django-cms",
     long_description=open('README.rst').read(),
-    install_requires = ['django',],
+    install_requires = ['django', 'easy-thumbnails',],
 )