From e35b0310a5fb941f7439ebeebd261db708dfeafd Mon Sep 17 00:00:00 2001
From: Aymeric Augustin
Date: Mon, 14 Oct 2013 22:48:09 +0200
Subject: Add a README for the example project.

---
 example/README.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 example/README.rst

(limited to 'example')

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
-- 
cgit v1.2.3