RafRaf avatar RafRaf committed 3ef362a

The README changed.

Comments (0)

Files changed (3)

 # file GENERATED by distutils, do NOT edit
-README.txt
 setup.py
 poll/__init__.py
 poll/admin.py
 poll/models.py
 poll/urls.py
 poll/utils.py
-poll/fixtures/initial_data.json
 poll/locale/ru/LC_MESSAGES/django.mo
 poll/locale/ru/LC_MESSAGES/django.po
 poll/templates/_polls_script.js
-Django poll system
+Django-poll-system (example: http://polltest.pythonism.ru)
 
 
 Requirements
 
-Django 1.3
+Django 1.3 or 1.4
 JQuery (There are some problems with animation in older versions.) 
-Django Internationalization (optionally)
-
 
 Installation
 
-Download or clone repository into the folder you like. Unpack it if needed and make an installation. The installation is simple, just type next command:
-   >> python setup.py install
+1. Install the package into your ecosystem
+    >> easy_install django_poll_system 
 
-Now you should config your site to use the poll application. Follow instructions below:
 
-
-1. Add the name of the application at the end of your INSTALLED_APPS (in settings.py), like this:
+2. Add it to your INSTALLED_APPS (in settings.py), like this:
 
 INSTALLED_APPS = (
 'django.contrib.auth',
 )
 
 
-2. Add the poll's url to your urls.py.
+3. Add the poll's url to your urls.py.
 
 from django.conf.urls.defaults import patterns, include, url
 
 urlpatterns += staticfiles_urlpatterns()
 
 
-3. Your TEMPLATE_CONTEXT_PROCESSORS (in settings.py) should looks like this:
+4. Your TEMPLATE_CONTEXT_PROCESSORS (in settings.py) should looks like this:
 
 TEMPLATE_CONTEXT_PROCESSORS = (
-    'django.core.context_processors.auth',
+    # Uncomment for Django 1.3
+	#'django.core.context_processors.auth',
+	# Uncomment for Django 1.4
+	#'django.contrib.auth.context_processors.auth',
     'django.core.context_processors.i18n',
     'django.core.context_processors.request',
     'django.core.context_processors.static',
 4. Eventually we need to do "syncdb".
    >> python manage.py syncdb
 
-ATTENTION: Don't forget this step. It's very important, because django-poll-system have a fixture that needs to be installed to DB.
 
-----
+5. Now installation is completed. After all you need to create a queue of polls and at least one poll for it.  
 
-Now installation is completed. After all, you have some data out of the box. And it's time to show the poll on your site. Add {% load polls_tags %} at the top of your page and insert {% poll_queue 'Public' %} to the place you want to see the django-poll-system component. Of course the script of JQuery library must be included (<script type="text/javascript" src="your/path/to/jquery.js"></script>) before you call "poll_queue".
 
-That's all. Try an example: http://polltest.pythonism.ru. (Please, leave your comments there)
+6. Insert the component into your page. Use the code snippet below to understand how to do that.  
+
+{% load polls_tags %}
+<html>
+	<head>
+		<title>Test page</title>
+		<script type="text/javascript" src="{{ STATIC_URL }}path_to_jquery/jquery.js"></script>
+	</head>
+	<body>
+		<h1>Test page</h1>
+		{% poll_queue "YourQueueName" %}
+	</body>
+</html>
+
+
+================================
+That's all. Try it: http://polltest.pythonism.ru. (Please, leave your comments there)
 from distutils.core import setup
 
 setup(name='django-poll-system',
-      version='0.2.0',
+      version='0.2.1',
       description='The application to organize polling (or voting) on your site.',
       author='RafRaf',
       maintainer='RafRaf',
       url='http://polltest.pythonism.ru',
       download_url='https://bitbucket.org/RafRaf/django-poll-system',
       packages=['poll', 'poll.templatetags'],
-      package_data={'poll': ['fixtures/initial_data.json', 'locale/ru/LC_MESSAGES/*', 'templates/*']},
+      package_data={'poll': ['locale/ru/LC_MESSAGES/*', 'templates/*']},
      )
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.