Merge branch 'hotfix/oberlin_references' into taggit
[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.3+ <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  * (philo.contrib.penfield) [django-taggit 0.9.3+ <https://github.com/alex/django-taggit>](https://github.com/alex/django-taggit)
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://project.philocms.org/) and/or make a fork of the git repository on [GitHub](http://github.com/ithinksw/philo) or [Gitorious](http://gitorious
14 .org/ithinksw/philo). Feel free to join us on IRC at [irc://irc.oftc.net/#philo](irc://irc.oftc.net/#philo).
15
16 Using philo
17 ===========
18
19 After installing philo and mptt on your python path, make sure to complete the following steps:
20
21 1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES.
22 2. add 'philo' and 'mptt' to settings.INSTALLED_APPS.
23 3. include 'philo.urls' somewhere in your urls.py file.
24 4. Optionally add a root node to your current Site.
25
26 Philo should be ready to go!