.. _ref-threadedcomments_extras-gettingstarted:

===============
Getting started
===============

This document is designed to get you up and running with the
``pinax.apps.threadedcomments_extras``...


Prerequisites
=============

These are the requirements to run ``pinax.apps.threadedcomments_extras``:

 * Python **2.4+** (Python 3.x is **not** supported yet)
 * Django **1.2+**

These dependencies should be added to your ``requirements/project.txt`` file
and installed using pip_. For example::

    pip install -r requirements/project.txt


Installation
============

Add ``pinax.apps.threadedcomments_extras`` to your ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        # ...
        "pinax.apps.threadedcomments_extras",
    ]


.. _ref-autocomplete_app-gettingstarted-usage:

Usage
=====

After installing this app in your Django project, you now have access to easily
add comments for a particular object in one of your templates.

Simple, load the template tag and call it within your template.

.. code-block:: html


    {% load comments_tag %}
    
    {% comments post %}


.. _pip: http://pip.openplans.org/