aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2012-10-09 09:32:59 +0100
committerPaul Eggleton <paul.eggleton@linux.intel.com>2012-10-09 09:32:59 +0100
commitaf9da3177b3a6afb59513095a1640e1cd5c394f4 (patch)
treec87054694af57cf46603992c882b15c1306c220c
parent08983e91e301b455cad38b9a1d176ec683f6c72f (diff)
downloadbuildhistory-web-af9da3177b3a6afb59513095a1640e1cd5c394f4.tar.gz
buildhistory-web-af9da3177b3a6afb59513095a1640e1cd5c394f4.tar.bz2
buildhistory-web-af9da3177b3a6afb59513095a1640e1cd5c394f4.zip
README: improve setup instructions
Explain how to set up the database and test the web application. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
-rw-r--r--README23
1 files changed, 20 insertions, 3 deletions
diff --git a/README b/README
index 503d4cc..704d148 100644
--- a/README
+++ b/README
@@ -16,7 +16,9 @@ Setup
In order to make use of this application you will need:
* A web server set up to host Django applications
-* A database supported by Django (SQLite, MySQL, etc.)
+* A database supported by Django (SQLite, MySQL, etc.). Django takes
+ care of creating the database itself, you just need to ensure that the
+ database server (if not using SQLite) is configured and running.
* On the machine that will run the import script (which does not have to
be the same machine as the web server - could be the build machine;
however it does still have to have Django installed and have access
@@ -29,8 +31,23 @@ In order to make use of this application you will need:
* GitPython (python-git) version 0.3.1 or later
* django-registration
-You'll need to edit settings.py to specify a database, EMAIL_HOST and
-other settings specific to your installation.
+Setup instructions:
+
+1. Edit settings.py to specify a database, EMAIL_HOST and other settings
+ specific to your installation.
+
+2. Run the following command within the buildhistory-web directory to
+ initialise the database:
+
+ python manage.py syncdb
+
+3. You can test the web application locally by running the following:
+
+ python manage.py runserver
+
+ Then visit http://127.0.0.1:8000/ with your browser. This should only
+ be used for testing - for production you need to use a proper web
+ server.
Usage