From 6d667fd2c34923e732223dc8dfad7dc3c4624949 Mon Sep 17 00:00:00 2001
From: leidel <leidel@cfb8ba98-e953-0410-9cff-959ffddf5974>
Date: Mon, 20 Oct 2008 23:19:26 +0000
Subject: [PATCH] Added simple documentation for sphinxified pinax docs

git-svn-id: https://django-dbtemplates.googlecode.com/svn/trunk@54 cfb8ba98-e953-0410-9cff-959ffddf5974

committer: leidel <leidel@cfb8ba98-e953-0410-9cff-959ffddf5974>

--HG--
extra : convert_revision : 40959e5a722723202a903ea874b31497caf1daa1
---
 docs/index.txt | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 docs/index.txt

diff --git a/docs/index.txt b/docs/index.txt
new file mode 100644
index 0000000..1965871
--- /dev/null
+++ b/docs/index.txt
@@ -0,0 +1,55 @@
+===================================
+Database template loader for Django
+===================================
+
+This is a basic database template loader for Django which uses a m2m
+relationship to provide a site centric template loading.
+
+How to use it in your own Django application
+============================================
+
+0. Get the source from the subversion repository
+1. Follow the instructions in the INSTALL file
+2. Edit the settings.py of your Django project:
+
+   Add ``dbtemplates`` to the ``INSTALLED_APPS`` of your django project
+ 
+   Check if ``django.contrib.sites`` and ``django.contrib.admin`` are in
+   ``INSTALLED_APPS`` and add if necessary.
+ 
+   It should look something like this::
+ 
+       INSTALLED_APPS = (
+           'django.contrib.auth',
+           'django.contrib.contenttypes',
+           'django.contrib.sessions',
+           'django.contrib.sites',
+           'django.contrib.admin',
+           'django.contrib.flatpages',
+           'dbtemplates',
+           'myapp.blog',
+       )
+ 
+   Add ``dbtemplates.loader.load_template_source`` to the
+   ``TEMPLATE_LOADERS`` list in the settings.py of your Django project
+ 
+   It should look something like this::
+ 
+       TEMPLATE_LOADERS = (
+           'django.template.loaders.filesystem.load_template_source',
+           'django.template.loaders.app_directories.load_template_source',
+           'dbtemplates.loader.load_template_source',
+       )
+
+3. Sync your database via shell (hint: "./manage.py syncdb" within project dir)
+4. Restart your Django server
+5. Go to the admin interface and add templates by filling the ``name`` field
+   with filename like identifiers, for example "blog/entry_list.html"
+6. Use it with ``Flatpages``, ``Generic views`` and your own custom views
+
+Support
+=======
+
+Please leave your questions and messages on the designated Google Code site:
+
+http://code.google.com/p/django-dbtemplates/