diff options
| author | Aymeric Augustin | 2013-10-14 22:48:09 +0200 |
|---|---|---|
| committer | Aymeric Augustin | 2013-10-14 23:30:04 +0200 |
| commit | e35b0310a5fb941f7439ebeebd261db708dfeafd (patch) | |
| tree | 07215ec4d54aca9be12b4e0df0b98884af55606c | |
| parent | 9af80c9704ea9e7a7b5581dcfb39008573ac9aaf (diff) | |
| download | django-debug-toolbar-e35b0310a5fb941f7439ebeebd261db708dfeafd.tar.bz2 | |
Add a README for the example project.
| -rw-r--r-- | example/README.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/example/README.rst b/example/README.rst new file mode 100644 index 0000000..aa044b9 --- /dev/null +++ b/example/README.rst @@ -0,0 +1,26 @@ +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 + +Before running the example for the first time, you must create a database:: + + $ django-admin.py syncdb --settings=example.settings + +Then you can use the following command to run the example:: + + $ django-admin.py runserver --settings=example.settings |