X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/8c6ffb8e54f201a0fb7776fdd865bbbb3d42a29b..ca4643640b3e41bc557ecd996d835e67ef707d5e:/README?ds=inline diff --git a/README b/README index e718287..4a89499 100644 --- a/README +++ b/README @@ -3,7 +3,25 @@ Philo is a foundation for developing web content management systems. Prerequisites: * Python 2.5.4+ * Django 1.2+ + * django-mptt e734079+ * (Optional) django-grappelli 2.0+ + * (Optional) south 0.7.2+ * (Optional) recaptcha-django r6 -To contribute, please visit the project website . +To contribute, please visit the project website . 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 \ No newline at end of file