aboutsummaryrefslogtreecommitdiffstats
path: root/example/README.rst
blob: e517d6fefbbe911cadc3c9fc9be3d6e22f4892a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
README
======

About
-----

This sample project demonstrates how to use the debug toolbar. It is designed
to run under the latest stable version of Django, currently 1.5.x.

It also provides a few test pages to ensure the debug toolbar doesn't
interfere with common JavaScript frameworks.

How to
------

The test project requires a working installation of Django::

    $ pip install Django

The following commands must be run from the root directory of a checkout of
the debug toolbar, ie. the directory that contains ``example/``.

Before running the example for the first time, you must create a database::

    $ PYTHONPATH=. django-admin.py syncdb --settings=example.settings

Then you can use the following command to run the example::

    $ PYTHONPATH=. django-admin.py runserver --settings=example.settings