From d3d214d121f0ab7ebe69d28340c48e6c9019bb5c Mon Sep 17 00:00:00 2001 From: Tim Buckley Date: Wed, 15 Jul 2015 12:38:17 -0600 Subject: [PATCH] add more information to readme --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2b38a8d..ef0b046 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ StackViz ======== -A visualization utility to help analyze the performance of DevStack setup and Tempest executions. +A visualization utility to help analyze the performance of DevStack setup and +Tempest executions. Installation ------------ @@ -20,10 +21,26 @@ bower install Usage ----- -The Django development server can be used to view the interface. Run: +First, install the necessary dependencies with Pip: + +```bash +sudo pip install -r requirements.txt +``` + +The Django development server may then be used to view the interface. Run: ```bash python manage.py runserver ``` -You can then browse to the printed URL in your browser of choice. \ No newline at end of file +You can then browse to the printed URL in your browser of choice. + +Log Locations +------------- +Log locations are configured along with normal Django settings in +`stackviz/settings.py`. Several different types of logs are rendered by +StackViz: + + * Tempest (`testr` repositories): `./`, `/opt/stack/tempest/` + * DevStack: *TODO* + * Dstat: *TODO*