changeset 53:a5cf65af6789 draft

Add more documentation regarding initial setup and running the server
author marga
date Sat, 29 Mar 2008 18:34:33 +0000
parents 9a86cdb2027a
children 0b17a5710d32
files bts_webui/README
diffstat 1 files changed, 23 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/bts_webui/README
+++ b/bts_webui/README
@@ -5,11 +5,29 @@
 client side helper.
 
 In order to run this, you need to have python and django installed.  The
-Django version this program was tested against is 0.95, then one included
-in Debian.
+Django versions this program was tested against are 0.95 and 0.96.
+
+INSTALLATION AND SETUP
+======================
+
+  Packages to install
+  -------------------
+
+    apt-get install python python-django python-pysqlite2 python-soappy
+
+  First time setup
+  ----------------
 
-Packages to install
--------------------
+  To get the necessary databases created you need to run:
+
+     python manage.py syncdb
+
+  From the main directory (bts_webui)
 
-apt-get install python python-django python-pysqlite2 python-soappy
+  Running the server
+  -----------------
 
+  After creating the databases, you can use the "runserver.sh" script to
+  have a local webserver, that will start running on the 8000 port by
+  default.  Change the script if you need to use a different port.
+