diff --git a/docs/installation.rst b/docs/installation.rst --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,4 +1,4 @@ -.. Copyright (C) 2013 Branko Majic +.. Copyright (C) 2013-2017 Branko Majic This file is part of Django Conntrackt documentation. @@ -11,7 +11,13 @@ Installation ============ -Django Conntrackt can be installed through one of the following methods: +*Django Conntrackt* has the following prerequisites that need to be +satisfied on the operating system level: + +- `Graphviz `_, used for generating the + diagrams. + +*Django Conntrackt* can be installed through one of the following methods: * Using *pip*, which is the recommended way for production websites. @@ -30,16 +36,6 @@ Mercurial repository, use the following pip install -e hg+http://code.majic.rs/conntrackt#egg=conntrackt -.. warning:: - - You will need to update the ``pip`` installation in your virtual environment if you get the following error while running the above command:: - - AttributeError: 'NoneType' object has no attribute 'skip_requirements_regex' - - You can update ``pip`` to latest version with:: - - pip install -U pip - After this you should proceed to :ref:`configure your Django installation `. @@ -51,8 +47,9 @@ Configuring your Django installation Once the Django Conntrackt has been installed, you need to perform the following steps in order to make it available inside of your Django project: -#. Edit your project's settings configuration file (``settings.py``), and update - the ``INSTALLED_APPS`` to include applications ``south``, ``braces`` and ``conntrackt``. +#. Edit your project's settings configuration file (``settings.py``), + and update the ``INSTALLED_APPS`` to include applications + ``braces``, ``crispy_forms``, and ``conntrackt``. #. Edit your project's URL configuration file (``urls.py``), and add the following line to the ``urlpatterns`` setting:: @@ -61,10 +58,11 @@ steps in order to make it available insi #. Create the necessary tables used for Django Conntrackt by running:: - ./manage.py syncdb + ./manage.py migrate After this the Django Conntrackt application will be available under the ``/conntrackt/`` path (relative to your Django project's base URL). -If you have enabled ``django.contrib.admin``, you should be able to add new -Conntrackt data through the admin interface. +If you have enabled ``django.contrib.admin``, you should be able to +add new Conntrackt data through admin interface as well - in addition +to native data entry provided by application.