Merge branch 'release' of git://github.com/melinath/philo
[philo.git] / docs / intro.rst
1 How to get started with philo
2 =============================
3
4 After installing `philo`_ and `mptt`_ on your python path, make sure to complete the following steps:
5
6 1. add :mod:`philo` and :mod:`mptt` to :setting:`settings.INSTALLED_APPS`::
7         
8         INSTALLED_APPS = (
9                 ...
10                 'philo',
11                 'mptt',
12                 ...
13         )
14         
15 2. add :class:`philo.middleware.RequestNodeMiddleware` to :setting:`settings.MIDDLEWARE_CLASSES`::
16         
17         MIDDLEWARE_CLASSES = (
18                 ...
19                 'philo.middleware.RequestNodeMiddleware',
20                 ...
21         )
22         
23 3. include :mod:`philo.urls` somewhere in your urls.py file. For example::
24         
25         from django.conf.urls.defaults import patterns, include, url
26         urlpatterns = patterns('',
27                 url(r'^', include('philo.urls')),
28         )
29         
30 4. Optionally add a root :class:`node <philo.models.Node>` to your current :class:`Site` in the admin interface.
31
32 Philo should be ready to go!
33
34 .. _philo: http://github.com/ithinksw/philo
35 .. _mptt: http://github.com/django-mptt/django-mptt