Added basic docs for entities and attributes.
[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.2+ <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) recaptcha-django r6 <http://code.google.com/p/recaptcha-django/>
9         * (Optional) south 0.7.2+ <http://south.aeracode.org/>
10
11 To contribute, please visit the project website <http://philo.ithinksw.org/>. Feel free to join us on IRC at irc://irc.oftc.net/#philo.
12
13 ====
14 Using philo
15 ====
16 After installing philo and mptt on your python path, make sure to complete the following steps:
17
18 1. add 'philo.middleware.RequestNodeMiddleware' to settings.MIDDLEWARE_CLASSES.
19 2. add 'philo' and 'mptt' to settings.INSTALLED_APPS.
20 3. include 'philo.urls' somewhere in your urls.py file.
21 4. Optionally add a root node to your current Site.
22
23 Philo should be ready to go!