README.txt 1.35 KB
Newer Older
Will LaShell's avatar
Will LaShell committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
=====
Lyrical Page
=====

Lyrical Page is a website development app for the Django framework. Roughly based
on the original Django flatpages contrib app with ideas pulled from a variety sources
across the internet.

The system is designed to be modular and compliment Django's philosophy of staying out
of the way of the developer. The code base has continued to evolve through real world use
in different types of websites.

Detailed documentation is a work in progress.

Quick start
-----------

1.  Add site_content, and site_seo to your INSTALLED_APPS in the following manner:

    INSTALLED_APPS = (
    ...
Brian Hrebec's avatar
Brian Hrebec committed
22
23
    'lyrical.site_content',
    'lyrical.site_seo',
Will LaShell's avatar
Will LaShell committed
24
25
26
27
28
29
    )

2.  If you are using the site_seo app, add the context processor to your settings file:

    TEMPLATE_CONTEXT_PROCESSORS = (
    ...
Brian Hrebec's avatar
Brian Hrebec committed
30
    'lyrical.site_seo.context_processors.site_seo',
Will LaShell's avatar
Will LaShell committed
31
32
33
34
35
36
37
    )

3.  Add the middleware classes to your settings file.  These middlware should be the last
    entries in your list/tuple.
    
    MIDDLEWARE_CLASSES = (
    ...
Brian Hrebec's avatar
Brian Hrebec committed
38
39
    'lyrical.site_content.middleware.SitePageFallbackMiddleware',
    'lyrical.site_seo.middleware.SiteSeoMiddleware',
Will LaShell's avatar
Will LaShell committed
40
41
42
43
44
45
46
47
    )

4.  Run 'python manage.py syncdb' to create new database tables and supplemental database
    actions.

5.  Log into the Django admin site and you can now add site_content site pages as you need.

Will LaShell <wlashell@lyrical.net>