Merge pull request #30 from antzucaro/setup-py-breakfix
[xonotic/xonstat.git] / README.md
index 60652c3925975835955f2bf1691038b05a8c489f..02e50b0fdc7d8af0fc9c3e34ebec7128e08c8aa6 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:
 
@@ -20,13 +29,13 @@ To start the server run the following from the root directory. I recommend runni
 
     pserve --reload development.ini #(or production.ini if you've configured that settings file instead)
 
-To get a Xonotic server configured to use this server, change the CVAR `g_playerstats_uri` to point to the correct host, port, and URL path. By default this is:
+To get a Xonotic server configured to use this server, change the CVAR `g_playerstats_gamereport_uri` to point to the correct host, port, and URL path. By default this is:
 
     http://localhost:6543/stats/submit
 
 ...so in the server console (or in your config) you can put:
 
-    set g_playerstats_uri http://localhost:6543/stats/submit
+    set g_playerstats_gamereport_uri http://localhost:6543/stats/submit
 
 If you have any questions or issues please open up a bug report here, or - better yet ! - fork it and send me a pull request.