Skip to content

Commit

Permalink
Merge pull request #37 from SocialSchools/fix/readme-travis
Browse files Browse the repository at this point in the history
try to fix readme and travis
  • Loading branch information
vinitkumar committed Feb 21, 2018
2 parents 944cee7 + b472273 commit 42061a4
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 42 deletions.
16 changes: 6 additions & 10 deletions .travis.yml
@@ -1,28 +1,24 @@
language: python
python:
- "2.7"
- "3.5"
- "3.6"

sudo: false

env:
- TOX_ENV=flake8
- TOX_ENV=py27-latest
- TOX_ENV=py35-latest
- TOX_ENV=py34-latest
# Django 1.8
- TOX_ENV=py27-dj18-cms34
- TOX_ENV=py27-dj18-cms33
- TOX_ENV=py35-dj18-cms34
- TOX_ENV=py35-dj18-cms33
- TOX_ENV=py34-dj18-cms34
- TOX_ENV=py34-dj18-cms33
# Django 1.9
- TOX_ENV=py27-dj19-cms34
- TOX_ENV=py27-dj19-cms33
- TOX_ENV=py35-dj19-cms34
- TOX_ENV=py35-dj19-cms33
- TOX_ENV=py34-dj19-cms34
- TOX_ENV=py34-dj19-cms33

install:
- pip install tox coverage

script:
- tox -e $TOX_ENV
- tox -e $TOX_ENV
54 changes: 23 additions & 31 deletions README.rst → README.md
@@ -1,15 +1,12 @@
=================
cmsplugin_gallery
=================
# cmsplugin_gallery

.. image:: https://travis-ci.org/centralniak/cmsplugin_gallery.svg?branch=master
:target: https://travis-ci.org/centralniak/cmsplugin_gallery
[![Build Status](https://travis-ci.org/centralniak/cmsplugin_gallery.svg?branch=master)](https://travis-ci.org/centralniak/cmsplugin_gallery)

cmsplugin_gallery adds simple gallery plugin to your djangoCMS installation
`cmsplugin_gallery` adds simple gallery plugin to your djangoCMS installation

Features:

- Drag&Drop reordering of photos in the plugin admin
- Drag & Drop reordering of photos in the plugin admin
- Unlimited, auto-discovered custom templates - you can change template
of given gallery at anytime, use javascript galleries etc.

Expand All @@ -28,22 +25,16 @@ Follow individual installation instructions before installing **cmsplugin_galler

Installation
============
#. `pip install cmsplugin_gallery`
#. Add `'cmsplugin_gallery'` to `INSTALLED_APPS` (if necessary)
#. Run `syncdb` or `migrate cmsplugin_gallery` if using South
```
`pip install cmsplugin_gallery`
Add `'cmsplugin_gallery'` to `INSTALLED_APPS` (if necessary)
Run Migrations
```

Configuration
=============


#. Supports Django version 1.8+ and latest Django CMS version.
#. Create directory for storing media files - files will be uploaded to
MEDIA_ROOT + 'cmsplugin_gallery/images'. Make sure it is writable especially
when running in embedded mode on production server.

#. Very simple template is included with the project. To make it work 100%,
install jQueryTOOLS for overlay support using your favorite method
http://flowplayer.org/tools/download/index.html

Usage
=====
Expand All @@ -56,13 +47,12 @@ by Django.
If you don't want to use the autodiscovery, you can hardcode available templates
in settings.py using following setting:

::

CMSPLUGIN_GALLERY_TEMPLATES = (
('app/template.html', 'Template #1', ),
('app/other_template.html', 'Template #2', ),
)

```
CMSPLUGIN_GALLERY_TEMPLATES = (
('app/template.html', 'Template #1', ),
('app/other_template.html', 'Template #2', ),
)
```
Embed as a typical plugin.

Bugs & Contribution
Expand All @@ -71,12 +61,14 @@ Bugs & Contribution
Please use Github to report bugs, feature requests and submit your code:
http://github.com/centralniak/cmsplugin_gallery

:author: Piotr Kilczuk
:date: 2012/08/01
```
author: Piotr Kilczuk
date: 2012/08/01
```

Current Maintainer:

:maintainer: Vinit Kumar
:date: 2016/08/23

.. _django-filer: https://github.com/stefanfoulis/django-filer/
```
maintainer: Vinit Kumar
date: 2016/08/23
```
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -14,5 +14,5 @@
packages=find_packages(),
provides=['cmsplugin_gallery', ],
include_package_data=True,
install_requires = ['django-inline-ordering>=0.1.1', 'easy-thumbnails',]
install_requires = ['django-cms>=3.2.0', 'django-inline-ordering>=0.1.1', 'easy-thumbnails',]
)

0 comments on commit 42061a4

Please sign in to comment.