X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/0d51e8dc2b15ca84b8979b94a3224b4a33f7f25e..e3a5cfb5fd8ae474cb0ed2104cb0d44eb4e567b7:/README?ds=sidebyside

diff --git a/README b/README
index 81a59cd..cb5f47a 100644
--- a/README
+++ b/README
@@ -2,9 +2,26 @@ Philo is a foundation for developing web content management systems.
 
 Prerequisites:
 	* Python 2.5.4+ <http://www.python.org/>
-	* simplejson <http://code.google.com/p/simplejson/> (Not required with Python 2.6+)
-	* Django 1.1.1+ <http://www.djangoproject.com/>
-	* django-mptt 0.2+ <http://code.google.com/p/django-mptt/>
+	* Django 1.3+ <http://www.djangoproject.com/>
+	* django-mptt e734079+ <https://github.com/django-mptt/django-mptt/>
 	* (Optional) django-grappelli 2.0+ <http://code.google.com/p/django-grappelli/>
+	* (Optional) south 0.7.2+ <http://south.aeracode.org/>
+	* (Optional) recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>
 
-To contribute, please visit the project website <http://philo.ithinksw.org/>.
+To contribute, please visit the project website <http://philo.ithinksw.org/>. Feel free to join us on IRC at irc://irc.oftc.net/#philo.
+
+====
+Using philo
+====
+After installing philo and mptt on your python path, make sure to complete the following steps:
+
+1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES.
+2. add 'philo' and 'mptt' to settings.INSTALLED_APPS.
+3. include 'philo.urls' somewhere in your urls.py file.
+4. Optionally add a root node to your current Site.
+
+Philo should be ready to go!
+
+If you are using philo.contrib.gilbert, you will additionally need to complete the following steps:
+
+1. add 'django.core.context_processors.request' to settings.TEMPLATE_CONTEXT_PROCESSORS