X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/72fac53a4cd42e6c9f56a581a85f8b47ba61b2ac..6de576dc999886f300c5abc74f4a2433a884d3b8:/README
diff --git a/README b/README
index 82333d6..71e8392 100644
--- a/README
+++ b/README
@@ -2,8 +2,21 @@ Philo is a foundation for developing web content management systems.
Prerequisites:
* Python 2.5.4+
- * simplejson (Not required with Python 2.6+)
- * Django 1.1.1+
+ * Django 1.3+
+ * django-mptt e734079+
* (Optional) django-grappelli 2.0+
+ * (Optional) south 0.7.2+
+ * (philo.contrib.penfield) django-taggit 0.9.3+
+ * (philo.contrib.waldo, optional) recaptcha-django r6
-To contribute, please visit the project website .
+====
+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! All that's left is to learn more and contribute .