Commits

gmh04 committed b6c6704

add initial documentation

Comments (0)

Files changed (3)

+cmsplugin_comments.egg-info
+dist
 syntax: glob
 *.orig
 .svn
+To install cmsplugin-comments
+
+pip install cmsplugin-comments
+
+Add url(r'^comments/', include('django.contrib.comments.urls')), to urls.py
+Add 'cmsplugin_comments' to INSTALLED_APPS
+
+To Enable captcha
+
+Add url(r'^captcha/',  include('captcha.urls')), to urls.py
+Add 'capcha' to INSTALLED_APPS
+Add COMMENTS_APP = 'cmsplugin_comments' to settings
+
+To Enable emailing of new messages to admins add the following to settings
+
+EMAIL_HOST=
+EMAIL_PORT=
+EMAIL_HOST_USER='my@email.com'
+EMAIL_HOST_PASSWORD='xxx'
+EMAIL_USE_TLS=True
+
+Add a comment_notification_email.txt template to {project-home}/templates/comments
+
+finally:
+
+manage.py syncdb
+manage.py migrate
 from setuptools import setup, find_packages
 setup(
-    name='cmsplugin_comments',
+    name='cmsplugin-comments',
     version= '0.1',
     description='A very simple plugin for django-cms 2 to implement comments',
-    author='X',
-    author_email='X',
-    url='http://bitbucket.org/genbit/cmsplugin_comments',
+    long_description=open('README.txt').read(),
+    #author='',
+    #author_email='X',
+    maintainer='gmh04',
+    maintainer_email='gmh04@netscape.net'
+    url='http://bitbucket.org/gmh04/cmsplugin_comments',
     license='MIT',
     packages=find_packages(),
     classifiers=[