From 5b32023c09f0f30226133d5094e6c5ee71e8c3af Mon Sep 17 00:00:00 2001 From: Sebastian Reyes Espinosa Date: Sat, 12 Nov 2016 10:55:16 -0500 Subject: [PATCH] Adding the package install instructions to the readme file --- README.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.rst b/README.rst index 4ce05ff..cf9223a 100644 --- a/README.rst +++ b/README.rst @@ -30,3 +30,33 @@ Features * Users have a reputation and a profile. * Support for tagging questions with django-taggit. * Questions are categorized by latest, popular and most voted. + +Installation +============ +Django-QA aims at keeping things simple. To install it you have to do what you would do with most django apps. + +Install with pip: +.. code-block:: bash + pip install django-qa + +Add to INSTALLED_APPS in your project settings. +.. code-block:: python + INSTALLED_APPS = ( + ... + qa, + ... + ) + +Add the package urls to the project: +.. code-block:: python + urlpatterns = [ + ..., + url(r'^', include('qa.urls')), + ... + ] + +Run migrations: +.. code-block:: bash + python manage.py migrate + +And that's it!