Update the README to be more clear about dependencies and building the actual app.
authorAnt Zucaro <azucaro@gmail.com>
Tue, 17 Oct 2017 23:56:42 +0000 (19:56 -0400)
committerAnt Zucaro <azucaro@gmail.com>
Tue, 17 Oct 2017 23:56:42 +0000 (19:56 -0400)
README.md

index 931c313..02e50b0 100644 (file)
--- 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: