Merge remote-tracking branch 'lapilofu/hotfix/manifest' into release

[philo.git] / README

diff --git a/README b/README
index 82333d6..71e8392 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,21 @@ 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 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/>
+       * (philo.contrib.penfield) django-taggit 0.9.3+ <https://github.com/alex/django-taggit>
+       * (philo.contrib.waldo, optional) recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>
 
-To contribute, please visit the project website <http://philo.ithinksw.org/>.
+====
+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 <http://philo.readthedocs.org> and contribute <http://philo.readthedocs.org/en/latest/contribute.html>.