From 94610a97de9323e46f076299acbdb601c3585db3 Mon Sep 17 00:00:00 2001 From: Ant Zucaro Date: Tue, 17 Oct 2017 19:56:42 -0400 Subject: [PATCH] Update the README to be more clear about dependencies and building the actual app. --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 931c313..02e50b0 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,18 @@ This is **XonStat**, the application in front of [xonstatdb][xonstatdb]. ---- -To start, first run the following from the root directory to set up dependencies: +To start, create a virtualenv and install dependencies: - python setup.py develop + virtualenv env + source env/bin/activate + +From within the directory you've cloned the repo, install the dependencies: + + pip install -r requirements.txt + +Next, install the application itself: + + pip install -e . Next you'll want to set up [xonstatdb][xonstatdb]. This is maintained as a separate project here: -- 2.39.2