X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/ba3be778c450d4f8d743bf395c0c2f7a88bf804d..cd38e4893698333050ac52a9242bee29371a080c:/docs/intro.rst

diff --git a/docs/intro.rst b/docs/intro.rst
new file mode 100644
index 0000000..33d1a98
--- /dev/null
+++ b/docs/intro.rst
@@ -0,0 +1,35 @@
+How to get started with philo
+=============================
+
+After installing `philo`_ and `mptt`_ on your python path, make sure to complete the following steps:
+
+1. add :mod:`philo` and :mod:`mptt` to :setting:`settings.INSTALLED_APPS`::
+	
+	INSTALLED_APPS = (
+		...
+		'philo',
+		'mptt',
+		...
+	)
+	
+2. add :class:`philo.middleware.RequestNodeMiddleware` to :setting:`settings.MIDDLEWARE_CLASSES`::
+	
+	MIDDLEWARE_CLASSES = (
+		...
+		'philo.middleware.RequestNodeMiddleware',
+		...
+	)
+	
+3. include :mod:`philo.urls` somewhere in your urls.py file. For example::
+	
+	from django.conf.urls.defaults import patterns, include, url
+	urlpatterns = patterns('',
+		url(r'^', include('philo.urls')),
+	)
+	
+4. Optionally add a root :class:`node <philo.models.Node>` to your current :class:`Site` in the admin interface.
+
+Philo should be ready to go!
+
+.. _philo: http://github.com/ithinksw/philo
+.. _mptt: http://github.com/django-mptt/django-mptt
\ No newline at end of file