All of my work from commits: dd4a194, 692644a, 4a60203, 5de46bc, 152042d, 64a2d4e...
[philo.git] / README.markdown
1 Philo is a foundation for developing web content management systems.
2
3 Prerequisites:
4
5  * [Python 2.5.4+ <http://www.python.org>](http://www.python.org/)
6  * [Django 1.2+ <http://www.djangoproject.com/>](http://www.djangoproject.com/)
7  * [django-mptt e734079+ <https://github.com/django-mptt/django-mptt/>](https://github.com/django-mptt/django-mptt/)
8  * [django-staticmedia 0.2+ <http://pypi.python.org/pypi/django-staticmedia/>](http://pypi.python.org/pypi/django-staticmedia/)
9  * (Optional) [django-grappelli 2.0+ <http://code.google.com/p/django-grappelli/>](http://code.google.com/p/django-grappelli/)
10  * (Optional) [south 0.7.2+ <http://south.aeracode.org/)](http://south.aeracode.org/)
11  * (Optional) [recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>](http://code.google.com/p/recaptcha-django/)
12
13 To contribute, please visit the [project website <http://philo.ithinksw.org/<](http://philo.ithinksw.org/). Feel free to join us on IRC at [irc://irc.oftc.net/#philo](irc://irc.oftc.net/#philo).
14
15 Using philo
16 ===========
17
18 After installing philo and mptt on your python path, make sure to complete the following steps:
19
20 1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES.
21 2. add 'philo' and 'mptt' to settings.INSTALLED_APPS.
22 3. include 'philo.urls' somewhere in your urls.py file.
23 4. Optionally add a root node to your current Site.
24
25 Philo should be ready to go!
26
27 If you are using philo.contrib.gilbert, you will additionally need to complete the following steps:
28
29 1. add 'django.core.context_processors.request' to settings.TEMPLATE_CONTEXT_PROCESSORS