Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Rename DjangoVoice to django-voice. Correct grammar and some typos.

  • Loading branch information...
commit 1b2e260c85e8d26a8301c4bd49e6351e00c4afad 1 parent 6f95f3f
@ahmet ahmet authored
Showing with 8 additions and 14 deletions.
  1. +8 −14 README.rst
View
22 README.rst
@@ -1,33 +1,31 @@
============
-Django Voice
+django-voice
============
-DjangoVoice is a very simple application to enable user feedback that is integrated with your Django project. Originally built for Verb (http://verbapp.com)
+django-voice is a very simple application to enable user feedback that is integrated with your Django project. Originally built for Verb (http://verbapp.com).
Installation and Dependencies
=============================
-Firtsly you have to satisfy dependencies which described in REQUIREMENTS file. Easy way to do is using pip_ installer with -r parameter.
+To satisfy dependencies listed in REQUIREMENTS you can simply run this command:
::
pip -r REQUIREMENTS
-this command will download and install dependencies required for django voice. After satisfying dependencies second step is activating helper applications to run.
+'pip' will automatically download and install dependencies required for django-voice. Next step is activating helper applications to run.
* Activate django's comment system. (https://docs.djangoproject.com/en/dev/ref/contrib/comments/)
* Add django-gravatar and django-voting to your INSTALLED_APPS in settings file.
- * Add comments and django voice to your url configration.
+ * Add comments and django-voice to your url configration.
-After you do these, your INSTALLED_APPS must be like this:
+After these steps, your INSTALLED_APPS in settings.py must be seen like this:
::
INSTALLED_APPS = (
...
- ...
- ...
'voting',
'gravatar',
'djangovoice'
@@ -39,21 +37,17 @@ and urls.py like this:
urlpatterns = patterns(
...
- ...
- ...
url(r'^comments/', include('django.contrib.comments.urls')),
url(r'^feedback/', include('djangovoice.urls')))
-These are all that you need to do run django voice.
+These are all that you need to do run django-voice.
AUTHORS
=======
-DjangoVoice was originall created by Huw Wilkins (http://huwshimi.com/)
+DjangoVoice was originally created by Huw Wilkins (http://huwshimi.com/)
Contributors:
* Ross Poulton http://rossp.org/
* Gökmen Görgen http://gokmengorgen.net/
* Mirat Can Bayrak http://miratcanbayrak.blogspot.com/
-
-.. _pip: http://www.pip-installer.org/en/latest/index.html
Please sign in to comment.
Something went wrong with that request. Please try again.