Modified Readme
authornyov <nyov@nexnode.net>
Sat, 5 May 2012 15:12:18 +0000 (17:12 +0200)
committernyov <nyov@nexnode.net>
Sat, 5 May 2012 15:12:18 +0000 (17:12 +0200)
README.md [new file with mode: 0644]
README.txt [deleted file]
TODO [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..07eceb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+This is **XonStat**, the application in front of [xonstatdb][xonstatdb].  
+[XonStat][xonstat] handles the submission of statistical information from the open source first person shooter [Xonotic][xonotic].
+
+----
+
+To start, first run the following from the root directory to set up dependencies:
+
+    python setup.py develop
+
+Next you'll want to set up [xonstatdb][xonstatdb]. This is maintained as a separate project here:
+
+    https://github.com/antzucaro/xonstatdb
+
+Next you'll want to open up development.ini and change a few things for added security. Chief among these is the "sqlalchemy.url" setting, which contains your username and password for the database. Change that match the new password you gave xonstat during the installation of xonstatdb. The other setting to change is "session.secret," which is used to keep your web session (cookies and such) secure.
+
+To start the server run the following from the root directory. I recommend running this within a GNU screen session:
+
+    paster serve 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:
+
+    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
+
+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.
+
+[xonstatdb]: https://github.com/antzucaro/xonstatdb
+[xonstat]: http://stats.xonotic.org/
+[xonotic]: http://www.xonotic.org/
+
+----
+
+Project is licensed GPLv2+.
diff --git a/README.txt b/README.txt
deleted file mode 100644 (file)
index 5fce5eb..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-This is XonStat, the application in front of xonstatdb. XonStat handles the submission of statistical information from the open source first person shooter Xonotic. 
-
-To start, first run the following from the root directory to set up dependencies:
-
-    python setup.py develop
-
-Next you'll want to set up xonstatdb. This is maintained as a separate project here:
-
-    https://github.com/antzucaro/xonstatdb
-
-Next you'll want to open up development.ini and change a few things for added security. Chief among these is the "sqlalchemy.url" setting, which contains your username and password for the database. Change that match the new password you gave xonstat during the installation of xonstatdb. The other setting to change is "security.secret," which is used to keep your web session (cookies and such) secure. 
-
-To start the server run the following from the root directory. I recommend running this within a GNU screen session:
-
-    paster serve 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:
-
-    http://localhost:6543/stats/submit
-
-...so in the command line of the server (or in your config) you can put:
-
-    set g_playerstats_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. 
-
-TODO:
-
-- "e matches" and "e joins" seem to be mutually exclusive. Add a check for either (instead of just joins" before adding a player_game_stats record).
-
-- map names are being recorded multiple times in the maps table. They should be found when being played subsequent times. 
diff --git a/TODO b/TODO
new file mode 100644 (file)
index 0000000..a279b07
--- /dev/null
+++ b/TODO
@@ -0,0 +1,6 @@
+TODO:
+
+- "e matches" and "e joins" seem to be mutually exclusive. Add a check for either (instead of just joins" before adding a player_game_stats record).
+
+- map names are being recorded multiple times in the maps table. They should be found when being played subsequent times. 
+