Added a 'contributing' page to the philo docs. This is meant primarily as an initial...
[philo.git] / README
1 Philo is a foundation for developing web content management systems.
2
3 Prerequisites:
4         * Python 2.5.4+ <http://www.python.org/>
5         * Django 1.3+ <http://www.djangoproject.com/>
6         * django-mptt e734079+ <https://github.com/django-mptt/django-mptt/> 
7         * (Optional) django-grappelli 2.0+ <http://code.google.com/p/django-grappelli/>
8         * (Optional) south 0.7.2+ <http://south.aeracode.org/>
9         * (Optional) recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>
10
11 ====
12 Using philo
13 ====
14 After installing philo and mptt on your python path, make sure to complete the following steps:
15
16 1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES.
17 2. add 'philo' and 'mptt' to settings.INSTALLED_APPS.
18 3. include 'philo.urls' somewhere in your urls.py file.
19 4. Optionally add a root node to your current Site.
20
21 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>.