Skip to content

Commit

Permalink
Merge pull request #62 from caktus/58-Update-README
Browse files Browse the repository at this point in the history
#58 - Updated README requirements and installation sections.
  • Loading branch information
benred42 committed Oct 1, 2015
2 parents 60df13f + dd68fb2 commit f848f7b
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,21 @@ Features

Requirements
------------
- `django <https://github.com/django/django/>`_ >= 1.4.2
- `django-mptt <http://github.com/django-mptt/django-mptt/>`_ >= 0.5.2
- `django <https://github.com/django/django/>`_ >= 1.7.10
- `django-mptt <http://github.com/django-mptt/django-mptt/>`_ >= 0.7.0

Using the demo
--------------

For a quick demo, follow these steps::

$ mkvirtualenv --distribute --no-site-packages django-treenav
$ mkvirtualenv --no-site-packages django-treenav
(django-treenav)$ git clone git://github.com/caktus/django-treenav.git
(django-treenav)$ cd django-treenav/
(django-treenav)~/django-treenav$ python setup.py develop
(django-treenav)~/django-treenav$ cd sample_project/
(django-treenav)~/django-treenav/sample_project$ pip install -r requirements.txt
(django-treenav)~/django-treenav/sample_project$ ./manage.py syncdb
(django-treenav)~/django-treenav/sample_project$ ./manage.py migrate
(django-treenav)~/django-treenav/sample_project$ ./manage.py runserver

Visit http://localhost:8000/ in your browser and follow the instructions.
Expand All @@ -86,19 +86,33 @@ Installation
)


#. Include these context processors::
#. Include these context processors:

- Django 1.7::

TEMPLATE_CONTEXT_PROCESSORS = (
"django.core.context_processors.request",
"treenav.context_processors.treenav_active",
)

- Django >= 1.8::

TEMPLATES = [
{
'OPTIONS': {
'context_processors': [
"django.template.context_processors.request",
"treenav.context_processors.treenav_active",
],
},
},
]

#. Add these urls::

urlpatterns = patterns('',
(r'^treenav/', include('treenav.urls')),
)
urlpatterns = [
url(r'^treenav/', include('treenav.urls')),
]


Development sponsored by `Caktus Consulting Group, LLC
Expand Down

0 comments on commit f848f7b

Please sign in to comment.